List Leads (Search)¶
POST https://api.copper.com/developer_api/v1/leads/search
The /search endpoint provides the ability to list Leads 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).
Certain fields can be filtered by an empty value, i.e., filter records where the field is not specified. For Leads, these fields are: city, state, postal_code, tags, custom dropdown, custom multi-select fields.
For an example of how this works, see Search by Empty Field. Some fields (e.g. assignee_ids)
can also filter for an empty value by specifying -2 as the ID.
To search by custom fields, see Search Entity by Custom Field
in the Custom Fields section of the docs.
Note that this endpoint is eligible to return computed custom field values, click here for more information.
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 |
|---|---|---|---|
| ids | identifier[] | An array of Lead IDs. | none |
| 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). | 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 Lead to search for. | none |
| phone_number | string | Phone number of the Lead to search for. | none |
| emails | string | Email of the Lead to search for. | none |
| assignee_ids | number[] | The ids of Users that Leads are assigned to (see footnote 2). | none |
| status_ids | number[] | An array of Lead status IDs (see footnote 3). | none |
| customer_source_ids | number[] | An array of customer source IDs (see footnote 4). | none |
| city | string | The city in which Leads must be located. | none |
| state | string | The state or province in which Leads must be located. | none |
| postal_code | string | The postal code in which Leads must be located. | none |
| country | string | The two character country code where Leads must be located. | none |
| tags | string[] | Filter Leads to those that match at least one of the tags specified. | none |
| socials | string[] | Filter Leads 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 each Lead must be. | none |
| minimum_monetary_value | number | The minimum monetary value Leads must have. | none |
| maximum_monetary_value | number | The maximum monetary value Leads must have. | none |
| minimum_interaction_count | number | The minimum number of interactions Leads must have had. | none |
| maximum_interaction_count | number | The maximum number of interactions Leads 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 Leads are created. | none |
| maximum_created_date | timestamp | The Unix timestamp of the latest date Leads are created. | none |
| minimum_modified_date | timestamp | The Unix timestamp of the earliest date Leads are modified. | none |
| maximum_modified_date | timestamp | The Unix timestamp of the latest date Leads are modified. | none |
| include_converted_leads | boolean | Specify if response should contain converted leads. | false |
Foonotes:
- Possible search fields are: name, company_name, title, value, email, phone, date_modified, date_created, city, state, country, zip, inactive_days, socials.
- date_modified and date_created: sorting is from oldest to newest
- inactive_days: sorting is from newest to oldest
- To get User IDs, see
List Usersin theAccount and Userssection of the docs. Enter -2 as an ID for no assignee. - To get lead status IDs, see
List Lead Statuses. - To get customer source IDs, see
List Customer Sources. Enter -2 as an ID for no customer source.
Request body¶
{
"page_size": 25,
"sort_by": "name"
}
Example Requests¶
Leads Search¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\"
}"
[
{
"id": 9150547,
"name": "My Contact",
"prefix": null,
"first_name": "My",
"last_name": "Contact",
"middle_name": null,
"suffix": null,
"address": null,
"assignee_id": null,
"company_name": null,
"customer_source_id": null,
"details": null,
"email": {
"email": "mycontact@noemail.com",
"category": "work"
},
"interaction_count": 0,
"monetary_value": null,
"socials": [],
"status": "New",
"status_id": 208231,
"tags": [],
"title": null,
"websites": [],
"phone_numbers": [],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"date_created": 1490045162,
"date_modified": 1490045162,
"date_last_contacted": 1490045162,
"converted_opportunity_id": null,
"converted_contact_id": null,
"converted_at": null
},
{
"id": 9150552,
"name": "My Contact",
"prefix": null,
"first_name": "My",
"last_name": "Contact",
"middle_name": null,
"suffix": null,
"address": null,
"assignee_id": null,
"company_name": null,
"customer_source_id": null,
"details": null,
"email": null,
"interaction_count": 0,
"monetary_value": null,
"socials": [],
"status": "New",
"status_id": 208231,
"tags": [],
"title": null,
"websites": [],
"phone_numbers": [
{
"number": "415-123-45678",
"category": "mobile"
}
],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"date_created": 1490045237,
"date_modified": 1490045237,
"date_last_contacted": 1490045237,
"converted_opportunity_id": null,
"converted_contact_id": null,
"converted_at": null
},
{
"id": 9150578,
"name": "My Contact",
"prefix": null,
"first_name": "My",
"last_name": "Contact",
"middle_name": null,
"suffix": null,
"address": null,
"assignee_id": null,
"company_name": null,
"customer_source_id": null,
"details": null,
"email": null,
"interaction_count": 0,
"monetary_value": null,
"socials": [],
"status": "New",
"status_id": 208231,
"tags": [],
"title": null,
"websites": [],
"phone_numbers": [
{
"number": "415-123-45678",
"category": "mobile"
}
],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"date_created": 1490045279,
"date_modified": 1490045279,
"date_last_contacted": 1490045279,
"converted_opportunity_id": null,
"converted_contact_id": null,
"converted_at": null
}
]
List Leads in groups of 200¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\"
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 1,
"monetary_unit": "USD",
"monetary_value": 2501,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"blah"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 8,
"value": null
},
{
"custom_field_definition_id": 11,
"value": null
},
{
"custom_field_definition_id": 9,
"value": null
},
{
"custom_field_definition_id": 7,
"value": false
},
{
"custom_field_definition_id": 3,
"value": null
},
{
"custom_field_definition_id": 4,
"value": null
},
{
"custom_field_definition_id": 10,
"value": null
},
{
"custom_field_definition_id": 5,
"value": null
}
],
"date_created": 1515434872,
"date_modified": 1516743967,
"date_last_contacted": 1515796263
},
{
"id": 5,
"name": "Pam Beesly (sample)",
"prefix": null,
"first_name": "Pam Beesly (sample)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": null,
"assignee_id": null,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
"email": {
"email": "pam@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 5000,
"socials": [],
"status": "Unqualified",
"status_id": 7,
"tags": [
"sample"
],
"title": "Office Coordinator",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5105553333",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 8,
"value": null
},
{
"custom_field_definition_id": 11,
"value": null
},
{
"custom_field_definition_id": 9,
"value": null
},
{
"custom_field_definition_id": 7,
"value": false
},
{
"custom_field_definition_id": 3,
"value": null
},
{
"custom_field_definition_id": 4,
"value": null
},
{
"custom_field_definition_id": 12,
"value": []
},
{
"custom_field_definition_id": 10,
"value": null
},
{
"custom_field_definition_id": 6,
"value": null
},
{
"custom_field_definition_id": 5,
"value": null
}
],
"date_created": 1515434872,
"date_modified": 1515795399,
"date_last_contacted": null
},
{
"id": 12,
"name": "Test User",
"prefix": null,
"first_name": "Test",
"last_name": "User",
"middle_name": null,
"suffix": null,
"address": {
"street": "123 Abc Rd",
"city": "San Francisco",
"state": "CA",
"postal_code": "94114",
"country": ""
},
"assignee_id": 2,
"company_name": null,
"customer_source_id": null,
"details": null,
"email": null,
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": null,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [],
"title": null,
"websites": [],
"phone_numbers": [],
"custom_fields": [
{
"custom_field_definition_id": 8,
"value": null
},
{
"custom_field_definition_id": 11,
"value": null
},
{
"custom_field_definition_id": 9,
"value": null
},
{
"custom_field_definition_id": 7,
"value": false
},
{
"custom_field_definition_id": 3,
"value": null
},
{
"custom_field_definition_id": 4,
"value": null
},
{
"custom_field_definition_id": 12,
"value": []
},
{
"custom_field_definition_id": 10,
"value": null
},
{
"custom_field_definition_id": 6,
"value": null
},
{
"custom_field_definition_id": 5,
"value": null
}
],
"date_created": 1516671366,
"date_modified": 1516671455,
"date_last_contacted": null
}
]
Search by Full Name¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\": \"Jim Halpert (sample2)\"
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 1,
"monetary_unit": "USD",
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"tag1"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
}
],
"date_created": 1515434872,
"date_modified": 1515800495,
"date_last_contacted": 1515796263
},
{
"id": 5,
"name": "Pam Beesly (sample)",
"prefix": null,
"first_name": "Pam Beesly (sample)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": null,
"assignee_id": null,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
"email": {
"email": "pam@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 5000,
"socials": [],
"status": "Unqualified",
"status_id": 7,
"tags": [
"sample"
],
"title": "Office Coordinator",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5105553333",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 12,
"value": []
},
{
"custom_field_definition_id": 6,
"value": null
}
],
"date_created": 1515434872,
"date_modified": 1515795399,
"date_last_contacted": null
}
]
Search by Followed¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 1,
"monetary_unit": "USD",
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"tag1"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515796276,
"date_last_contacted": 1515796263
}
]
Search by Assignee IDs¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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]
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": 2500,
"socials": [],
"status": "Unqualified",
"status_id": 7,
"tags": [],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515783705,
"date_last_contacted": null
}
]
Search by Interaction Count¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\": 1,
\"maximum_interaction_count\": 1
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 1,
"monetary_unit": "USD",
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"tag1"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515796276,
"date_last_contacted": 1515796263
}
]
Search by City¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\": \"Philadelphia\"
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"tag1"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515795800,
"date_last_contacted": null
}
]
Search by State¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\": \"PA\"
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"tag1"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515795800,
"date_last_contacted": null
}
]
Search by Postal Code¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\": \"18503\"
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"tag1"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515795800,
"date_last_contacted": null
}
]
Search by Country¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\": \"US\"
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"tag1"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515795800,
"date_last_contacted": null
}
]
Search by Customer Source IDs¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\",
\"customer_source_ids\": [4]
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515786833,
"date_last_contacted": null
},
{
"id": 5,
"name": "Pam Beesly (sample)",
"prefix": null,
"first_name": "Pam Beesly (sample)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": null,
"assignee_id": null,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
"email": {
"email": "pam@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": 5000,
"socials": [],
"status": "Unqualified",
"status_id": 7,
"tags": [
"sample"
],
"title": "Office Coordinator",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5105553333",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515525131,
"date_last_contacted": null
}
]
Search by Email¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\",
\"emails\": \"jim@dundermifflin.com\"
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 1,
"monetary_unit": "USD",
"monetary_value": 2501,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"blah"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
}
],
"date_created": 1515434872,
"date_modified": 1516214189,
"date_last_contacted": 1515796263
}
]
Search by Monetary Value¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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_monetary_value\": 2500,
\"maximum_monetary_value\": 2500
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515795399,
"date_last_contacted": null
}
]
Search by Phone Number¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\": \"5104447778\"
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 1,
"monetary_unit": "USD",
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"tag1"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
}
],
"date_created": 1515434872,
"date_modified": 1515800495,
"date_last_contacted": 1515796263
}
]
Search by Status IDs¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\",
\"status_ids\": [7]
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": 2500,
"socials": [],
"status": "Unqualified",
"status_id": 7,
"tags": [],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515783705,
"date_last_contacted": null
},
{
"id": 5,
"name": "Pam Beesly (sample)",
"prefix": null,
"first_name": "Pam Beesly (sample)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": null,
"assignee_id": null,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
"email": {
"email": "pam@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": 5000,
"socials": [],
"status": "Unqualified",
"status_id": 7,
"tags": [
"sample"
],
"title": "Office Coordinator",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5105553333",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515525131,
"date_last_contacted": null
}
]
Search by Tags¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\": [\"blah\"] }
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 1,
"monetary_unit": "USD",
"monetary_value": 2501,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"blah"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
}
],
"date_created": 1515434872,
"date_modified": 1516214189,
"date_last_contacted": 1515796263
}
]
Search by Socials¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\"]
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 1,
"monetary_unit": "USD",
"monetary_value": 2501,
"socials": [
{
"url": "https://www.linkedin.com/in/jimhalpert",
"category": "linkedin"
}
],
"status": "New",
"status_id": 5,
"tags": [
"blah"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
}
],
"date_created": 1515434872,
"date_modified": 1516214189,
"date_last_contacted": 1515796263
}
]
Search by Created Date¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\": 1515434000,
\"maximum_created_date\": 1515435000
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 1,
"monetary_unit": "USD",
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"tag1"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515796276,
"date_last_contacted": 1515796263
},
{
"id": 5,
"name": "Pam Beesly (sample)",
"prefix": null,
"first_name": "Pam Beesly (sample)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": null,
"assignee_id": null,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
"email": {
"email": "pam@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 5000,
"socials": [],
"status": "Unqualified",
"status_id": 7,
"tags": [
"sample"
],
"title": "Office Coordinator",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5105553333",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515795399,
"date_last_contacted": null
}
]
Search by Modified Date¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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_modified_date\": 1515796000,
\"maximum_modified_date\": 1515797000
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 1,
"monetary_unit": "USD",
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"tag1"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515796276,
"date_last_contacted": 1515796263
}
]
Search by Interaction Date¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\": 1515796000,
\"maximum_interaction_date\": 1515797000
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 1,
"monetary_unit": "USD",
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"tag1"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515796276,
"date_last_contacted": 1515796263
}
]
Search by Status Change Date¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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_status_change_date\": 1515786000,
\"maximum_status_change_date\": 1515787000
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 1,
"monetary_unit": "USD",
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"tag1"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [],
"date_created": 1515434872,
"date_modified": 1515796276,
"date_last_contacted": 1515796263
}
]
Search by Empty Field¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\": { \"allow_empty\": true, \"value\": \"Philadelphia\" }
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 1,
"monetary_unit": "USD",
"monetary_value": 2501,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"blah"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
}
],
"date_created": 1515434872,
"date_modified": 1516214189,
"date_last_contacted": 1515796263
},
{
"id": 5,
"name": "Pam Beesly (sample)",
"prefix": null,
"first_name": "Pam Beesly (sample)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": null,
"assignee_id": null,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
"email": {
"email": "pam@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 5000,
"socials": [],
"status": "Unqualified",
"status_id": 7,
"tags": [
"sample"
],
"title": "Office Coordinator",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5105553333",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 12,
"value": []
},
{
"custom_field_definition_id": 6,
"value": null
}
],
"date_created": 1515434872,
"date_modified": 1515795399,
"date_last_contacted": null
}
]
Search by Custom Multi-Select Dropdown¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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\"
}]
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 1,
"monetary_unit": "USD",
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"tag1"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
}
],
"date_created": 1515434872,
"date_modified": 1515800495,
"date_last_contacted": 1515796263
}
]
Search by Custom Multi-Select Dropdown Set to Empty¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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
}]
}"
[
{
"id": 5,
"name": "Pam Beesly (sample)",
"prefix": null,
"first_name": "Pam Beesly (sample)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": null,
"assignee_id": null,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
"email": {
"email": "pam@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 5000,
"socials": [],
"status": "Unqualified",
"status_id": 7,
"tags": [
"sample"
],
"title": "Office Coordinator",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5105553333",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 12,
"value": []
},
{
"custom_field_definition_id": 6,
"value": null
}
],
"date_created": 1515434872,
"date_modified": 1515795399,
"date_last_contacted": null
}
]
Search by Custom Date Field¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/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
}]
}"
[
{
"id": 6,
"name": "Jim Halpert (sample2)",
"prefix": null,
"first_name": "Jim Halpert (sample2)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Philadelphia",
"state": "PA",
"postal_code": "18503",
"country": "US"
},
"assignee_id": 2,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 4,
"details": "This is an update",
"email": {
"email": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 1,
"monetary_unit": "USD",
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 5,
"tags": [
"tag1"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": []
}
],
"date_created": 1515434872,
"date_modified": 1515800180,
"date_last_contacted": 1515796263
}
]