List People (Search)¶
POST https://api.copper.com/developer_api/v1/people/search
The /search endpoint provides the ability to list people and sort the results by certain parameters. When multiple criteria are provided, records meeting ALL criteria will be returned (the filtering criteria have an 'AND' relationship).
Note that this endpoint is eligible to return computed custom field values, click here for more information.
To see examples of search request using the various parameters, click on the People Search
dropdown on the right. Certain fields can be filtered by an empty value, i.e., filter records where the field is not specified. For People, these fields are: city, state, postal_code, tags, custom dropdown, custom multi-select fields. Some fields (e.g. assignee_ids) can also filter for an empty value by specifying -2 as the ID.
To change the number of records returned, change the "page_size" parameter. E.g., specify 200 for a page size of 200 records. Please note that search requests are limited to returning only the first 100,000 records regardless of the pagination parameters. If your search filter matches more than 100,000 records, we recommend modifying your search filter to separate your result set.
Field | Type | Details | Default |
---|---|---|---|
page_number | number | The page number (starting with 1) that you would like to view. | 1 |
page_size | number | The number of entries included in a page of results | 20 |
sort_by | string | The field on which to sort the results (see footnote 1). | first_name |
sort_direction | string | The direction in which to sort the results. Possible values are: asc or desc. | asc |
name | string | Full name of the People to search for. | none |
phone_number | string | Phone number of the People to search for. | none |
emails | string[] | Emails of the People to search for. | none |
contact_type_ids | identifier[] | The contact type Ids to search for (see footnote 2). | none |
assignee_ids | identifier[] | The ids of Users that People must be owned by, or -2 for People with no owner. | none |
company_ids | identifier[] | The ids of Companies that People belong to, or -2 for People with no company. | none |
opportunity_ids | identifier[] | An array of Opportunity IDs (see footnote 3). | none |
city | string | The city in which People must be located. | none |
state | string | The state or province in which People must be located. | none |
postal_code | string | The postal code in which People must be located. | none |
country | string | The two character country code where People must be located. | none |
tags | string[] | Filter People to those that match at least one of the tags specified. | none |
socials | string[] | Filter People to those that match at least one of the social accounts specified. | none |
followed | number | 1: followed, 2: not followed | none |
age | number | The maximum age in seconds that People must be. | none |
minimum_interaction_count | number | The minimum number of interactions People must have had. | none |
maximum_interaction_count | number | The maximum number of interactions People must have had. | none |
minimum_interaction_date | timestamp | The Unix timestamp of the earliest date of the last interaction. | none |
maximum_interaction_date | timestamp | The Unix timestamp of the latest date of the last interaction. | none |
minimum_created_date | timestamp | The Unix timestamp of the earliest date People are created. | none |
maximum_created_date | timestamp | The Unix timestamp of the latest date People are created. | none |
Footnotes:
- Possible search fields are: name, title, email, phone, date_modified, date_created, city, state, country, zip, socials.
- See
List Contact Types
under Other Resources folder. - See
List Opportunities (Search)
in the Opportunities section of the docs.
Request Body¶
1 2 3 4 | { "page_size": 25, "sort_by": "name" } |
Examples¶
People Search¶
1 2 3 4 5 6 7 8 9 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\" }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 | [ { "id": 7, "name": "Jim Halpert", "prefix": null, "first_name": "Jim", "middle_name": null, "last_name": "Halpert", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "Vancouver", "state": "BC", "postal_code": "A1A1A1", "country": "CA" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jhalpert@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4158546956", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jimhalpert", "category": "linkedin" } ], "tags": [ "tag1" ], "title": "Business Development", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 6, "value": 1515744000 }, { "custom_field_definition_id": 12, "value": [ 8 ] } ], "date_created": 1516262400, "date_modified": 1516313340, "date_last_contacted": 1516313330, "interaction_count": 2, "leads_converted_from": [], "date_lead_created": null } ] |
Search by State¶
1 2 3 4 5 6 7 8 9 10 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"state\": \"BC\" }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 | [ { "id": 7, "name": "Jim Halpert", "prefix": null, "first_name": "Jim", "middle_name": null, "last_name": "Halpert", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "Vancouver", "state": "BC", "postal_code": "A1A1A1", "country": "CA" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jhalpert@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4158546956", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jimhalpert", "category": "linkedin" } ], "tags": [ "tag1" ], "title": "Business Development", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 6, "value": 1515744000 }, { "custom_field_definition_id": 12, "value": [ 8 ] } ], "date_created": 1516262400, "date_modified": 1516313340, "date_last_contacted": 1516313330, "interaction_count": 2, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Postal Code¶
1 2 3 4 5 6 7 8 9 10 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"postal_code\": \"A1A1A1\" }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | [ { "id": 7, "name": "Jim Halpert", "prefix": null, "first_name": "Jim", "middle_name": null, "last_name": "Halpert", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "Vancouver", "state": "BC", "postal_code": "A1A1A1", "country": "CA" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jhalpert@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4158546956", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jimhalpert", "category": "linkedin" } ], "tags": [], "title": "Business Development", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1516262400, "date_modified": 1516311811, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Followed¶
1 2 3 4 5 6 7 8 9 10 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"followed\": 1 }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | [ { "id": 4, "name": "Jack James", "prefix": null, "first_name": "Jack", "middle_name": null, "last_name": "James", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country": "" }, "assignee_id": 2, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 5, "details": "This is an update", "emails": [ { "email": "jackjames@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4153554776", "category": "work" } ], "socials": [ { "url": "www.linkedin.com/pub/jack-james/54/172/b47", "category": "linkedin" } ], "tags": [], "title": "Customer Support", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434863, "date_modified": 1516308658, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Tags¶
1 2 3 4 5 6 7 8 9 10 11 12 13 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"tags\": { \"option\": \"ANY\", \"value\": [\"tag1\"] } }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 | [ { "id": 7, "name": "Jim Halpert", "prefix": null, "first_name": "Jim", "middle_name": null, "last_name": "Halpert", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "Vancouver", "state": "BC", "postal_code": "A1A1A1", "country": "CA" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jhalpert@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4158546956", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jimhalpert", "category": "linkedin" } ], "tags": [ "tag1" ], "title": "Business Development", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1516262400, "date_modified": 1516312015, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Socials¶
1 2 3 4 5 6 7 8 9 10 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"socials\": [\"https://www.linkedin.com/in/jimhalpert\"] }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 | [ { "id": 7, "name": "Jim Halpert", "prefix": null, "first_name": "Jim", "middle_name": null, "last_name": "Halpert", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "Vancouver", "state": "BC", "postal_code": "A1A1A1", "country": "CA" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jhalpert@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4158546956", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jimhalpert", "category": "linkedin" } ], "tags": [ "tag1" ], "title": "Business Development", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1516262400, "date_modified": 1516312015, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Date Added¶
1 2 3 4 5 6 7 8 9 10 11 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"minimum_created_date\": 1516262400, \"maximum_created_date\": 1516272400 }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | [ { "id": 7, "name": "Jim Halpert", "prefix": null, "first_name": "Jim", "middle_name": null, "last_name": "Halpert", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country": "" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jhalpert@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4158546956", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jimhalpert", "category": "linkedin" } ], "tags": [], "title": "Business Development", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1516262400, "date_modified": 1516299712, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Opportunity Ids¶
1 2 3 4 5 6 7 8 9 10 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"opportunity_ids\": [4] }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 | [ { "id": 5, "name": "Michael Scott, (sample)", "prefix": null, "first_name": "Michael", "middle_name": null, "last_name": "Scott", "suffix": "(sample)", "address": { "street": "213 West Main Street", "city": "Scranton", "state": "PA", "postal_code": "18501", "country": "" }, "assignee_id": null, "company_id": 3, "company_name": "Dunder Mifflin (sample)", "contact_type_id": 5, "details": null, "emails": [ { "email": "michael@dundermifflin.com", "category": "work" } ], "phone_numbers": [ { "number": "4152225466", "category": "work" } ], "socials": [], "tags": [], "title": "Regional Manager", "websites": [ { "url": "http://www.dundermifflin.com/index.shtml", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434864, "date_modified": 1516310945, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Custom Multi-Select Dropdown¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"custom_fields\": [{ \"custom_field_definition_id\": 12, \"value\": [8], \"option\": \"ANY\" }] }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 | [ { "id": 7, "name": "Jim Halpert", "prefix": null, "first_name": "Jim", "middle_name": null, "last_name": "Halpert", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "Vancouver", "state": "BC", "postal_code": "A1A1A1", "country": "CA" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jhalpert@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4158546956", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jimhalpert", "category": "linkedin" } ], "tags": [ "tag1" ], "title": "Business Development", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 6, "value": 1515744000 }, { "custom_field_definition_id": 12, "value": [ 8 ] } ], "date_created": 1516262400, "date_modified": 1516312771, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |
Search by City¶
1 2 3 4 5 6 7 8 9 10 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"city\": \"Scranton\" }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 | [ { "id": 5, "name": "Michael Scott, (sample)", "prefix": null, "first_name": "Michael", "middle_name": null, "last_name": "Scott", "suffix": "(sample)", "address": { "street": "213 West Main Street", "city": "Scranton", "state": "PA", "postal_code": "18501", "country": "" }, "assignee_id": null, "company_id": 3, "company_name": "Dunder Mifflin (sample)", "contact_type_id": 5, "details": null, "emails": [ { "email": "michael@dundermifflin.com", "category": "work" } ], "phone_numbers": [ { "number": "4152225466", "category": "work" } ], "socials": [], "tags": [], "title": "Regional Manager", "websites": [ { "url": "http://www.dundermifflin.com/index.shtml", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434864, "date_modified": 1516310945, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Interaction Count¶
1 2 3 4 5 6 7 8 9 10 11 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"minimum_interaction_count\": 2, \"maximum_interaction_count\": 2 }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 | [ { "id": 7, "name": "Jim Halpert", "prefix": null, "first_name": "Jim", "middle_name": null, "last_name": "Halpert", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "Vancouver", "state": "BC", "postal_code": "A1A1A1", "country": "CA" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jhalpert@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4158546956", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jimhalpert", "category": "linkedin" } ], "tags": [ "tag1" ], "title": "Business Development", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 6, "value": 1515744000 }, { "custom_field_definition_id": 12, "value": [ 8 ] } ], "date_created": 1516262400, "date_modified": 1516313340, "date_last_contacted": 1516313330, "interaction_count": 2, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Assignee Id¶
1 2 3 4 5 6 7 8 9 10 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"assignee_ids\": [2] }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | [ { "id": 4, "name": "Jack James", "prefix": null, "first_name": "Jack", "middle_name": null, "last_name": "James", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country": "" }, "assignee_id": 2, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": "This is an update", "emails": [ { "email": "jackjames@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4153554776", "category": "work" } ], "socials": [ { "url": "www.linkedin.com/pub/jack-james/54/172/b47", "category": "linkedin" } ], "tags": [], "title": "Customer Support", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434863, "date_modified": 1516299085, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Full Name¶
1 2 3 4 5 6 7 8 9 10 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"name\": \"Jack James\" }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | [ { "id": 4, "name": "Jack James", "prefix": null, "first_name": "Jack", "middle_name": null, "last_name": "James", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country": "" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": "This is an update", "emails": [ { "email": "jackjames@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4153554776", "category": "work" } ], "socials": [ { "url": "www.linkedin.com/pub/jack-james/54/172/b47", "category": "linkedin" } ], "tags": [], "title": "Customer Support", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434863, "date_modified": 1516240218, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Phone Number¶
1 2 3 4 5 6 7 8 9 10 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"phone_number\": \"4153554776\" }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 | [ { "id": 4, "name": "Jack James", "prefix": null, "first_name": "Jack", "middle_name": null, "last_name": "James", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country": "" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": "This is an update", "emails": [ { "email": "jackjames@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4153554776", "category": "work" } ], "socials": [ { "url": "www.linkedin.com/pub/jack-james/54/172/b47", "category": "linkedin" } ], "tags": [], "title": "Customer Support", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434863, "date_modified": 1516240218, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null }, { "id": 3, "name": "Jon Lee", "prefix": null, "first_name": "Jon", "middle_name": null, "last_name": "Lee", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country": "" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jonlee@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4153554776", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jonlee168", "category": "linkedin" } ], "tags": [], "title": "CEO", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434862, "date_modified": 1515434877, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Country¶
1 2 3 4 5 6 7 8 9 10 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"country\": \"CA\" }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | [ { "id": 7, "name": "Jim Halpert", "prefix": null, "first_name": "Jim", "middle_name": null, "last_name": "Halpert", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "Vancouver", "state": "BC", "postal_code": "A1A1A1", "country": "CA" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jhalpert@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4158546956", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jimhalpert", "category": "linkedin" } ], "tags": [], "title": "Business Development", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1516262400, "date_modified": 1516311811, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Last Interaction Date¶
1 2 3 4 5 6 7 8 9 10 11 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"minimum_interaction_date\": 0, \"maximum_interaction_date\": 1516313331 }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 | [ { "id": 7, "name": "Jim Halpert", "prefix": null, "first_name": "Jim", "middle_name": null, "last_name": "Halpert", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "Vancouver", "state": "BC", "postal_code": "A1A1A1", "country": "CA" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jhalpert@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4158546956", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jimhalpert", "category": "linkedin" } ], "tags": [ "tag1" ], "title": "Business Development", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 6, "value": 1515744000 }, { "custom_field_definition_id": 12, "value": [ 8 ] } ], "date_created": 1516262400, "date_modified": 1516313340, "date_last_contacted": 1516313330, "interaction_count": 2, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Contact Type¶
1 2 3 4 5 6 7 8 9 10 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"contact_type_ids\": [5] }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 | [ { "id": 6, "name": "Jo Bennett, (sample)", "prefix": null, "first_name": "Jo", "middle_name": null, "last_name": "Bennett", "suffix": "(sample)", "address": { "street": "543 Washington Ave", "city": "Philadelphia", "state": "PA", "postal_code": "19135", "country": "" }, "assignee_id": null, "company_id": 4, "company_name": "Sabre Inc (sample)", "contact_type_id": 5, "details": null, "emails": [ { "email": "jo@sabreinc.com", "category": "work" } ], "phone_numbers": [], "socials": [], "tags": [], "title": "CEO", "websites": [], "custom_fields": [ { "custom_field_definition_id": 8, "value": null } ], "date_created": 1515434865, "date_modified": 1515525462, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null }, { "id": 5, "name": "Michael Scott, (sample)", "prefix": null, "first_name": "Michael", "middle_name": null, "last_name": "Scott", "suffix": "(sample)", "address": { "street": "213 West Main Street", "city": "Scranton", "state": "PA", "postal_code": "18501", "country": "" }, "assignee_id": null, "company_id": 3, "company_name": "Dunder Mifflin (sample)", "contact_type_id": 5, "details": null, "emails": [ { "email": "michael@dundermifflin.com", "category": "work" } ], "phone_numbers": [ { "number": "4152225466", "category": "work" } ], "socials": [], "tags": [], "title": "Regional Manager", "websites": [ { "url": "http://www.dundermifflin.com/index.shtml", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434864, "date_modified": 1515434877, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Company Id¶
1 2 3 4 5 6 7 8 9 10 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"company_id\": 2 }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 | [ { "id": 4, "name": "Jack James", "prefix": null, "first_name": "Jack", "middle_name": null, "last_name": "James", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country": "" }, "assignee_id": 2, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": "This is an update", "emails": [ { "email": "jackjames@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4153554776", "category": "work" } ], "socials": [ { "url": "www.linkedin.com/pub/jack-james/54/172/b47", "category": "linkedin" } ], "tags": [], "title": "Customer Support", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434863, "date_modified": 1516299085, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null }, { "id": 3, "name": "Jon Lee", "prefix": null, "first_name": "Jon", "middle_name": null, "last_name": "Lee", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country": "" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jonlee@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4153554776", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jonlee168", "category": "linkedin" } ], "tags": [], "title": "CEO", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434862, "date_modified": 1515434877, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null }, { "id": 7, "name": "Jim Halpert", "prefix": null, "first_name": "Jim", "middle_name": null, "last_name": "Halpert", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country": "" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jhalpert@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4158546956", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jimhalpert", "category": "linkedin" } ], "tags": [], "title": "Business Development", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1516262400, "date_modified": 1516299712, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |
List People in Groups of 200¶
1 2 3 4 5 6 7 8 9 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 200, \"sort_by\": \"name\" }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 | [ { "id": 4, "name": "Jack James", "prefix": null, "first_name": "Jack", "middle_name": null, "last_name": "James", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country": "" }, "assignee_id": 2, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 5, "details": "This is an update", "emails": [ { "email": "jackjames@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4153554776", "category": "work" } ], "socials": [ { "url": "www.linkedin.com/pub/jack-james/54/172/b47", "category": "linkedin" } ], "tags": [], "title": "Customer Support", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434863, "date_modified": 1516308658, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null }, { "id": 6, "name": "Jo Bennett, (sample)", "prefix": null, "first_name": "Jo", "middle_name": null, "last_name": "Bennett", "suffix": "(sample)", "address": { "street": "543 Washington Ave", "city": "Philadelphia", "state": "PA", "postal_code": "19135", "country": "" }, "assignee_id": null, "company_id": 4, "company_name": "Sabre Inc (sample)", "contact_type_id": 5, "details": null, "emails": [ { "email": "jo@sabreinc.com", "category": "work" } ], "phone_numbers": [], "socials": [], "tags": [], "title": "CEO", "websites": [], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434865, "date_modified": 1515525462, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null }, { "id": 3, "name": "Jon Lee", "prefix": null, "first_name": "Jon", "middle_name": null, "last_name": "Lee", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country": "" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jonlee@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4153554776", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jonlee168", "category": "linkedin" } ], "tags": [], "title": "CEO", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 12, "value": [ 9 ] }, { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434862, "date_modified": 1516313029, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null }, { "id": 5, "name": "Michael Scott, (sample)", "prefix": null, "first_name": "Michael", "middle_name": null, "last_name": "Scott", "suffix": "(sample)", "address": { "street": "213 West Main Street", "city": "Scranton", "state": "PA", "postal_code": "18501", "country": "" }, "assignee_id": null, "company_id": 3, "company_name": "Dunder Mifflin (sample)", "contact_type_id": 5, "details": null, "emails": [ { "email": "michael@dundermifflin.com", "category": "work" } ], "phone_numbers": [ { "number": "4152225466", "category": "work" } ], "socials": [], "tags": [], "title": "Regional Manager", "websites": [ { "url": "http://www.dundermifflin.com/index.shtml", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434864, "date_modified": 1516310945, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null }, { "id": 7, "name": "Jim Halpert", "prefix": null, "first_name": "Jim", "middle_name": null, "last_name": "Halpert", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "Vancouver", "state": "BC", "postal_code": "A1A1A1", "country": "CA" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jhalpert@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4158546956", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jimhalpert", "category": "linkedin" } ], "tags": [ "tag1" ], "title": "Business Development", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 6, "value": 1515744000 }, { "custom_field_definition_id": 12, "value": [ 8 ] } ], "date_created": 1516262400, "date_modified": 1516313340, "date_last_contacted": 1516313330, "interaction_count": 2, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Custom Date Field¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"custom_fields\": [{ \"custom_field_definition_id\": 6, \"minimum_value\": 1515744000, \"maximum_value\": 1515745000 }] }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 | [ { "id": 7, "name": "Jim Halpert", "prefix": null, "first_name": "Jim", "middle_name": null, "last_name": "Halpert", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "Vancouver", "state": "BC", "postal_code": "A1A1A1", "country": "CA" }, "assignee_id": null, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 8, "details": null, "emails": [ { "email": "jhalpert@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4158546956", "category": "work" } ], "socials": [ { "url": "https://www.linkedin.com/in/jimhalpert", "category": "linkedin" } ], "tags": [ "tag1" ], "title": "Business Development", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 6, "value": 1515744000 }, { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1516262400, "date_modified": 1516312656, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |
Search by Custom Multi-Select Dropdown Set to Empty¶
1 2 3 4 5 6 7 8 9 10 11 12 13 | curl --location --request POST "https://api.copper.com/developer_api/v1/people/search" \ --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \ --header "X-PW-Application: developer_api" \ --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \ --header "Content-Type: application/json" \ --data "{ \"page_size\": 25, \"sort_by\": \"name\", \"custom_fields\": [{ \"custom_field_definition_id\": 12, \"allow_empty\": true }] }" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 | [ { "id": 4, "name": "Jack James", "prefix": null, "first_name": "Jack", "middle_name": null, "last_name": "James", "suffix": null, "address": { "street": "221 Main Street Suite 1350", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country": "" }, "assignee_id": 2, "company_id": 2, "company_name": "ProsperWorks", "contact_type_id": 5, "details": "This is an update", "emails": [ { "email": "jackjames@prosperworks.com", "category": "work" } ], "phone_numbers": [ { "number": "4153554776", "category": "work" } ], "socials": [ { "url": "www.linkedin.com/pub/jack-james/54/172/b47", "category": "linkedin" } ], "tags": [], "title": "Customer Support", "websites": [ { "url": "www.prosperworks.com", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434863, "date_modified": 1516308658, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null }, { "id": 6, "name": "Jo Bennett, (sample)", "prefix": null, "first_name": "Jo", "middle_name": null, "last_name": "Bennett", "suffix": "(sample)", "address": { "street": "543 Washington Ave", "city": "Philadelphia", "state": "PA", "postal_code": "19135", "country": "" }, "assignee_id": null, "company_id": 4, "company_name": "Sabre Inc (sample)", "contact_type_id": 5, "details": null, "emails": [ { "email": "jo@sabreinc.com", "category": "work" } ], "phone_numbers": [], "socials": [], "tags": [], "title": "CEO", "websites": [], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434865, "date_modified": 1515525462, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null }, { "id": 5, "name": "Michael Scott, (sample)", "prefix": null, "first_name": "Michael", "middle_name": null, "last_name": "Scott", "suffix": "(sample)", "address": { "street": "213 West Main Street", "city": "Scranton", "state": "PA", "postal_code": "18501", "country": "" }, "assignee_id": null, "company_id": 3, "company_name": "Dunder Mifflin (sample)", "contact_type_id": 5, "details": null, "emails": [ { "email": "michael@dundermifflin.com", "category": "work" } ], "phone_numbers": [ { "number": "4152225466", "category": "work" } ], "socials": [], "tags": [], "title": "Regional Manager", "websites": [ { "url": "http://www.dundermifflin.com/index.shtml", "category": "work" } ], "custom_fields": [ { "custom_field_definition_id": 8, "value": null }, { "custom_field_definition_id": 11, "value": null } ], "date_created": 1515434864, "date_modified": 1516310945, "date_last_contacted": null, "interaction_count": 0, "leads_converted_from": [], "date_lead_created": null } ] |