URL: https://developer.copper.com/
Copper Developer API¶
The Copper Web API allows you to access and build your own applications that interact with Copper in more complex ways than the integrations we provide out of the box.
The Copper Developer API (“Dev API”) provides a RESTful interface with JSON-formatted responses to access most Copper resources. We are continuously working on expanding our API functionality, so stay tuned!
Changelog ð¶
We have added a public changelog, please click here.
Domain Update â ︶
Please note that we’ve recently updated our domain to reflect an earlier application rebranding.
Our developer api can be found at https://api.copper.com/developer_api/, previously it was at https://api.prosperworks.com/developer_api/.
We are currently supporting auto-redirects for requests being made to the old domain and will continue to do so until early 2022.
Please update your Dev API requests with the new domain as soon as possible.
Change Policy¶
Our Developer API Change Policy is available here.
This policy defines how we will continue to support and maintain this Developer API going forward.
Postman Resources¶
To easily interact with the Copper Developer API, you may download our:
Import the Collection¶
To import the collection, open Postman and click Import, then select “Import From Link”
Copy & Paste the following link and press the “Import” button:
https://developer.copper.com/download/copper_postman_collection.json
Import and Use the Environment¶
To import the environment, open Postman and click Import, then select “Import From Link”
Copy & Paste the following link and press the “Import” button:
https://developer.copper.com/download/copper_postman_environment.json
After importing the environment, set it as your active environment in the top right-hand corner:
URL: https://developer.copper.com/introduction/changelog.html
Changelog¶
March 10, 2025¶
Added a new endpoint to list field layout by entity type.
January 9, 2025¶
Added a new endpoint to bulk create opportunities.
December 5, 2024¶
Added an optional tag_names_only parameter to the tags index endpoint.
November 11, 2024¶
Added the pipeline record type type and revenue type is_revenue to the pipeline list endpoint.
Added the pipeline record type pipeline_type and pipeline revenue type pipeline_is_revenue to the opportunity endpoints.
October 30, 2024¶
Added primary contact as filter criteria for “list opportunities” endpoint.
June 19, 2024¶
Added ability to fetch the current API user.
Added minor clarification to the OAuth2.0 flow.
April 24, 2024¶
Added support for primary contact management on company records.
November 1, 2023¶
Added corrections to the OAuth2.0 Quickstart Guide.
September 14, 2023¶
Added support for “Medium” and “Low” task priorities.
August 22, 2023¶
Bulk APIs Available (BETA â ï¸)¶
You can now bulk-create people, leads, organizations and activities and bulk-update people, leads and organizations using our new Bulk APIs. Note that these APIs are in beta and still undergoing final testing before their official release.
August 14, 2023¶
Headers Supported in Webhooks¶
You can now pass custom HTTP headers to your webhooks.
August 11, 2023¶
OAuth2.0 Support¶
We now support OAuth2.0 as the preferred authentication approach for partner integrations. Click here to get started.
July 20, 2023¶
Search by Ids¶
You can now pass an ids field (numeric array of entity ids) as search parameters to the POST search endpoints for People/ Leads/ Opportunities/ Companies/ Projects/ Tasks in order to retrieve a specific set of entities in bulk.
March 9 2023¶
New Field is_filterable for CustomFieldDefinitions¶
We now return the is_filterable field for all CustomFieldDefinition responses. Previously this field was only exposed via the webapp but now it can be set to true/false when creating or updating CustomFieldDefinitions via the Developer API. When creating CustomFieldDefinitions, this field defaults to false.
February 14, 2023¶
New Primary Timezone field for Account¶
We now return a primary_timezone name field for the GET account response.
December 5, 2022¶
Invalid Target Error For Webhook Subscription Create/Update¶
If you provide a target that is considered to be invalid when creating or updating a webhook subscription, a 422 error will be returned.
June 15, 2022¶
Custom Field Definition Canonical Name¶
You can specify a canonical_name on Custom Field Definition creation and it will be downcased automatically if provided.
June 15, 2022¶
Moved page_size to relevent area¶
We have moved some information about page_size from the list-companies-search to the pagination page.
January 12, 2022¶
Changelog Added¶
Added this public changelog page.
Search By Social Media Accounts¶
You can now search for Leads, People and Companies by social media account url! See linked search endpoint documentation for more information.
Computed Custom Field Values For Endpoints & Webhooks¶
You can now retreive entities from relevant endpoints and receive webhook requests with custom field values evaluated to their easy-to-read labels instead of their option ids, click here for more information.
December 13, 2021¶
New Webhook Request Timestamp Field¶
The payload of a webhook request now contains a ISO 8601 timestamp string field called “timestamp”. Click here for more information.
October 29, 2021¶
Postman Environment¶
We’ve added a downloadable Postman Environment for use with the suite, see here
October 15, 2021¶
Get Tags Index¶
We added a new endpoint to get a list of all tags and how many entities they are associated to. Click here for more information.
September 17, 2021¶
Added Update Activity Endpoint¶
We’ve added documentation for the pre-existing Update Activity endpoint, see here
September 7, 2021¶
Change Policy¶
Please note that we have published a change policy, please click here.
This policy defines how we will continue to support and maintain this Developer API going forward.
August 18, 2021¶
Domain Update¶
Please note that we’ve recently updated our domain to reflect an earlier application rebranding.
Our developer api can be found at https://api.copper.com/developer_api/, previously it was at https://api.prosperworks.com/developer_api/.
We are currently supporting auto-redirects for requests being made to the old domain and will continue to do so until early 2022.
Please update your Dev API requests with the new domain as soon as possible.
URL: https://developer.copper.com/field-layouts/list-field-layout-by-entity-type.html
List Field Layout by Entity Type¶
GET https://api.copper.com/developer_api/v1/field_layouts/by_entity/:entity_type?pipeline_id=X
Field Layouts¶
A field layout is an array of field objects. It defines which fields are applicable to a given entity type, as well as the order in which they are displayed. Field layouts are configured in app.copper.com under Settings > Manage Fields On Records.
When requesting a field layout for the “opportunities” entity_type, you MUST specify a pipeline_id as well.
Field Attributes¶
Each field in a field layout has the following attributes
| Field | Type | Details |
| field_id | identifier | The id of the field. Default fields are just sequential integers, custom-fields and embedded-app_fields are the ids of those entities. |
| field_label | string | The user-friendly label of the field. |
| field_key | string | An internal identifying name of the field. Custom fields follow the format cf_. Embedded-app fields are defined as embedded_. |
| field_type | string | The field type, either ‘static_field’, ‘custom_field’ or ’embedded_app_field’ |
| enabled | boolean | If the field is enabled for the current entity_type in the webapp. |
| required | boolean | If the field is required to be set on create. |
| required_editable | boolean | If the field is required to be set on edit. |
Example Requests¶
People Field Layout¶
curl --location --request GET "https://api.copper.com/developer_api/v1/field_layouts/by_entity/people" \
--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"[
{
"field_id": 0,
"field_label": "Name",
"field_key": "full_name",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 2,
"field_label": "Company",
"field_key": "primary_organization",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 1,
"field_label": "Title",
"field_key": "title",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 3,
"field_label": "Contact Type",
"field_key": "contact_group_id",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 4,
"field_label": "Owner",
"field_key": "assignee",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 5,
"field_label": "Emails",
"field_key": "emails",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 6,
"field_label": "Phones",
"field_key": "phones",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 7,
"field_label": "Websites",
"field_key": "websites",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 8,
"field_label": "Social Media Accounts",
"field_key": "socials",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 9,
"field_label": "Address",
"field_key": "address",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 10,
"field_label": "Visibility",
"field_key": "visibility",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 11,
"field_label": "Description",
"field_key": "details",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 12,
"field_label": "Tags",
"field_key": "tags",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 23,
"field_label": "My Custom Field",
"field_key": "cf_23",
"field_type": "custom_field",
"enabled": false,
"required": true,
"required_editable": true
}
]Opportunities Field Layout¶
curl --location --request GET "https://api.copper.com/developer_api/v1/field_layouts/by_entity/opportunities?pipeline_id=123" \
--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"[
{
"field_id": 0,
"field_label": "Name",
"field_key": "name",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": false
},
{
"field_id": 5,
"field_label": "Pipeline",
"field_key": "pipeline_id",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": false
},
{
"field_id": 1,
"field_label": "Primary Contact",
"field_key": "related_contact",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 2,
"field_label": "Close Date",
"field_key": "deal_date",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 3,
"field_label": "Company",
"field_key": "related_organization",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 4,
"field_label": "Status",
"field_key": "status",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": false
},
{
"field_id": 6,
"field_label": "Owner",
"field_key": "assignee",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 7,
"field_label": "Stage",
"field_key": "stage_id",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": false
},
{
"field_id": 8,
"field_label": "Source",
"field_key": "customer_source_id",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 9,
"field_label": "Created",
"field_key": "created_date",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": false
},
{
"field_id": 10,
"field_label": "Value",
"field_key": "monetary_value",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 11,
"field_label": "Priority",
"field_key": "priority",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 12,
"field_label": "Win Percentage",
"field_key": "win_probability",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 13,
"field_label": "Loss Reason",
"field_key": "loss_reason_id",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 14,
"field_label": "Visibility",
"field_key": "visibility",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": false
},
{
"field_id": 15,
"field_label": "Description",
"field_key": "details",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 16,
"field_label": "Tags",
"field_key": "tags",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 24,
"field_label": "DealCF1",
"field_key": "cf_24",
"field_type": "custom_field",
"enabled": true,
"required": false,
"required_editable": true
}
]URL: https://developer.copper.com/opportunities/bulk-create-opportunities.html
Bulk Create Opportunities¶
POST https://api.copper.com/developer_api/v1/opportunities/bulk_create
BETA Disclaimer â ︶
Please note that our new bulk create/update APIs (including this one) are still undergoing final testing before their official release.
We reserve the right to increase or decrease the maximum request size of these APIs (see the Request Size Limit section).
Should you encounter any issues, please let us know so we can diagnose and resolve them. Your help in this regard is greatly appreciated.
Request Size Limit¶
This is a bulk-create endpoint with a maximum request size of 10. If you sent a request larger than that limit, you will receive a 422 back with response:
{
“error”: “Request size too large, limit is 10”
}
{
"error": "Request size too large, limit is 10"
}Responses¶
All valid requests (JSON is formatted correctly on request) will result in a 200 OK. Bulk APIs guarantee the same response object ordering as the request objects meaning you can match each response object up to the request’s objects easily.
If an object is created successfully, it will be returned in the response array in the same JSON structure you would expect from the single-create endpoint. The key thing to look for is a present and numeric id value.
If an object fails to create, it’s response object (within the response array) will look like this:
{
“success”: false,
“message”: {
“name”: [
{
“error”: “invalid”
}
]
}
}
{
"success": false,
"message": {
"name": [
{
"error": "invalid"
}
]
}
}Notes¶
Some other notes about this bulk API:
- This endpoint is eligible to return computed custom field values, click here for more information.
- Our bulk APIs have an additional rate limit of 3 requests per second. You may receive 429 error responses if you exceed this limit.
Request Body¶
The request body is just an array of single-create JSON Request objects within an array with a key of “opportunities”, as seen below:
{
"opportunities": [
{
"name": "New Deal",
"primary_contact_id": 15706048,
"assignee_id": 1145608,
"close_date": "12/12/2025",
"details": "This is a new deal!",
"monetary_value": 1000,
"pipeline_id": 1079900,
"priority": "Low",
"status": "Open",
"tags": ["special"],
"win_probability": 50,
"custom_fields": []
}
]
}Example Requests¶
Create New Person¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/bulk_create" \
--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 '{
"opportunities": [
{
"name": "Deal One"
"primary_contact_id": 27140359,
"customer_source_id": 331242
},
{
"name": "Deal Two",
"primary_contact_id": 27140322,
"customer_source_id": 331251
}
]
}'[
{
"id": 123,
"name": "Deal One",
"assignee_id": 1105608,
"close_date": "12/12/2025",
"company_id": null,
"company_name": null,
"customer_source_id": 331242,
"details": "This is a new deal!",
"loss_reason_id": null,
"pipeline_id": 1079900,
"pipeline_is_revenue": true,
"pipeline_stage_id": 4878195,
"pipeline_type": "opportunity",
"primary_contact_id": 27140359,
"priority": "Low",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 1000.0,
"converted_unit": null,
"converted_value": null,
"win_probability": 50,
"date_stage_changed": 1736361775,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1736361775,
"date_modified": 1736361775,
"custom_fields": []
},
{
"id": 124,
"name": "Deal Two",
"assignee_id": 1105608,
"close_date": "12/12/2025",
"company_id": null,
"company_name": null,
"customer_source_id": 331251,
"details": "This is a new deal!",
"loss_reason_id": null,
"pipeline_id": 1079900,
"pipeline_is_revenue": true,
"pipeline_stage_id": 4878195,
"pipeline_type": "opportunity",
"primary_contact_id": 27140322,
"priority": "Low",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 1000.0,
"converted_unit": null,
"converted_value": null,
"win_probability": 50,
"date_stage_changed": 1736361776,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1736361775,
"date_modified": 1736361775,
"custom_fields": []
}
]URL: https://developer.copper.com/custom-fields/general/computed_cf_values.html
Computed Custom Field Values¶
What is a Computed Custom Field?¶
The following types of Custom Fields return option ids instead of option labels:
- Dropdown Fields
- Multi-select Dropdown Fields
For example, you may have a custom field with id = 1 called “Favorite Ice Cream Flavor”. Below are its options ids and values:
When it is returned as part of any endpoint that returns an entity with custom fields included, by default it will be returned like this:
{
“custom_fields”: [
{
“custom_field_definition_id”: 1,
“value”: [1, 2]
}
]
}
{
"custom_fields": [
{
"custom_field_definition_id": 1,
"value": [1, 2]
}
]
}The option ids 1 and 2 need to be mapped back to their corresponding labels of “Chocolate” and “Vanilla” via a call to GET /v1/custom_field_definitions which causes an extra request to be made. As a convenience to reduce HTTP traffic with your rate limit in mind, you may provide an optional query param custom_field_computed_values=true (providing a false value produces the default behavior) to any eligible endpoints that return custom fields in order to retrieve the custom field’s “computed_value”. See example below:
{
“custom_fields”: [
{
“custom_field_definition_id”: 1,
“value”: [1, 2],
“computed_value”: [“Chocolate”, “Vanilla”]
}
]
}
{
"custom_fields": [
{
"custom_field_definition_id": 1,
"value": [1, 2],
"computed_value": ["Chocolate", "Vanilla"]
}
]
}Note that all other types of Custom Fields will return “computed_value” with the same value as the “value” field. See example below:
{
“custom_fields”: [
{
“custom_field_definition_id”: 2,
“value”: “example text”,
“computed_value”: “example text”
}
]
}
{
"custom_fields": [
{
"custom_field_definition_id": 2,
"value": "example text",
"computed_value": "example text"
}
]
}Eligible Endpoints¶
People¶
Leads¶
Companies¶
Opportunities¶
Projects¶
Tasks¶
Webhooks¶
A similar functionality is also available for Webhooks. You can create a new webhook or update an existing webhook with the parameter “custom_field_computed_values”: true/false (boolean value) in order to be returned the computed values instead of the standard value.
Click here an example of a webhook request with computed custom field values.
URL: https://developer.copper.com/people/fetch-a-person-by-id.html
Fetch a Person by ID¶
GET https://api.copper.com/developer_api/v1/people/{{example_person_id}}
Note that this endpoint is eligible to return computed custom field values, click here for more information.
Examples¶
Fetch a Person by ID¶
curl --location --request GET "https://api.copper.com/developer_api/v1/people/{{example_person_id}}" \
--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"{
"id": 27140442,
"name": "My Contact",
"prefix": null,
"first_name": "My",
"middle_name": null,
"last_name": "Contact",
"suffix": null,
"address": null,
"assignee_id": null,
"company_id": null,
"company_name": null,
"contact_type_id": 451492,
"details": null,
"emails": [
{
"email": "mycontact_123@noemail.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "415-123-45678",
"category": "mobile"
}
],
"socials": [],
"tags": [],
"title": null,
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"date_created": 1490045413,
"date_modified": 1490045413,
"interaction_count": 0
}URL: https://developer.copper.com/people/fetch-a-person-by-email.html
Fetch a Person by Email¶
POST https://api.copper.com/developer_api/v1/people/fetch_by_email
Email address is a unique key for People records in Copper. You can fetch a Person by its email address using this operation.
Note that this endpoint is eligible to return computed custom field values, click here for more information.
Request Body¶
{
"email": "mycontact_123@noemail.com"
}Example Requests¶
Fetch by Email¶
curl --location --request POST "https://api.copper.com/developer_api/v1/people/fetch_by_email" \
--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 "{
\"email\": \"mycontact_123@noemail.com\"
}"{
"id": 27140442,
"name": "My Contact",
"prefix": null,
"first_name": "My",
"middle_name": null,
"last_name": "Contact",
"suffix": null,
"address": null,
"assignee_id": null,
"company_id": null,
"company_name": null,
"contact_type_id": 451492,
"details": null,
"emails": [
{
"email": "mycontact_123@noemail.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "415-123-45678",
"category": "mobile"
}
],
"socials": [],
"tags": [],
"title": null,
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"date_created": 1490045413,
"date_modified": 1490045413,
"interaction_count": 0
}URL: https://developer.copper.com/people/create-a-new-person.html
Create a New Person¶
POST https://api.copper.com/developer_api/v1/people
Note that this endpoint is eligible to return computed custom field values, click here for more information.
Request Body¶
{
"name":"My Contact",
"emails": [
{
"email":"mycontact_1233@noemail.com",
"category":"work"
}
],
"address": {
"street": "123 Main Street",
"city": "Savannah",
"state": "Georgia",
"postal_code": "31410",
"country": "United States"
},
"phone_numbers": [
{
"number":"415-123-45678",
"category":"mobile"
}
]
}Example Requests¶
Create New Person¶
curl --location --request POST "https://api.copper.com/developer_api/v1/people" \
--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 "{
\"name\":\"My Contact\",
\"emails\": [
{
\"email\":\"mycontact_1233@noemail.com\",
\"category\":\"work\"
}
],
\"phone_numbers\": [
{
\"number\":\"415-123-45678\",
\"category\":\"mobile\"
}
]
}"{
"id": 27140448,
"name": "My Contact",
"prefix": null,
"first_name": "My",
"middle_name": null,
"last_name": "Contact",
"suffix": null,
"address": null,
"assignee_id": null,
"company_id": null,
"company_name": null,
"contact_type_id": 451492,
"details": null,
"emails": [
{
"email": "mycontact_1233@noemail.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "415-123-45678",
"category": "mobile"
}
],
"socials": [],
"tags": [],
"title": null,
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"date_created": 1490045450,
"date_modified": 1490045450
}URL: https://developer.copper.com/people/update-a-person.html
Update a Person¶
PUT https://api.copper.com/developer_api/v1/people/{{example_person_id}}
Updates are only applied to fields explicitly specified in the request body. For example, if an update request is made with an empty body, no updates will be made. To remove the value from a field, the request body must specify the target field value as ‘null’.
The field company_id is returned in the JSON response, However, if you would like to unrelate and relate a new company_id, use the related items API call to delete and then add a new company_id to the person record. For more info, see Related Items folder.
Note that this endpoint is eligible to return computed custom field values, click here for more information.
Request Body¶
{
"details":"This is an update"
}Example Requests¶
Person Update¶
curl --location --request PUT "https://api.copper.com/developer_api/v1/people/{{example_person_id}}" \
--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 "{
\"details\":\"This is an update\"
}"{
"id": 26443553,
"name": "Person Default",
"prefix": null,
"first_name": "Person",
"middle_name": null,
"last_name": "Default",
"suffix": null,
"address": {
"street": "",
"city": "",
"state": "",
"postal_code": "",
"country": ""
},
"assignee_id": 137658,
"company_id": null,
"company_name": null,
"contact_type_id": 451490,
"details": "This is an update",
"emails": [],
"phone_numbers": [],
"socials": [],
"tags": [],
"title": null,
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"date_created": 1489018908,
"date_modified": 1496699863,
"interaction_count": 0
}URL: https://developer.copper.com/people/list-people-search.html
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 |
| ids | identifier[] | An array of People 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). | 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:
Request Body¶
{
"page_size": 25,
"sort_by": "name"
}Examples¶
People Search¶
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\"
}"[
{
"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¶
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\"
}"[
{
"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¶
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\"
}"[
{
"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¶
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
}"[
{
"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¶
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\"]
}
}"[
{
"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¶
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\"]
}"[
{
"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¶
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
}"[
{
"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¶
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]
}"[
{
"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¶
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\"
}]
}"[
{
"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¶
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\"
}"[
{
"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¶
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
}"[
{
"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¶
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]
}"[
{
"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¶
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\"
}"[
{
"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¶
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\"
}"[
{
"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¶
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\"
}"[
{
"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¶
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
}"[
{
"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¶
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]
}"[
{
"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¶
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
}"[
{
"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¶
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\"
}"[
{
"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¶
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
}]
}"[
{
"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¶
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
}]
}"[
{
"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
}
]URL: https://developer.copper.com/people/list-contact-types.html
List Contact Types¶
GET https://api.copper.com/developer_api/v1/contact_types
Contact Types are categories into which you can place your People and Companies to classify your relationships with them. The Contact Types API allows you to retrieve the list of Contact Types associated with your Copper account.
| Field | Type | Details |
| id | identifier | Unique identifier for the Contact Type. |
| name | string | The name of the Contact Type. |
Examples¶
List Contact Types¶
curl --location --request GET "https://api.copper.com/developer_api/v1/contact_types" \
--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"[
{
"id": 451490,
"name": "Potential Customer"
},
{
"id": 451491,
"name": "Current Customer"
},
{
"id": 451492,
"name": "Uncategorized"
},
{
"id": 451493,
"name": "Other"
}
]URL: https://developer.copper.com/opportunities/list-opportunities-search.html
List Opportunities (Search)¶
POST https://api.copper.com/developer_api/v1/opportunities/search
The /search endpoint provides the ability to list records and sort the results by certain parameters. When multiple ciriteria
are provided then 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 Opportunities,
these fields are: company_ids, tags, custom dropdown, custom multi-select fields.
For an example of how this works, see Search Opportunities 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 under Custom Fields folder.
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 Opportunity 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 Opportunity to search for. | none |
| assignee_ids | identifier[] | The ids of Users that Opportunities must be owned by, or -2 for Opportunities with no owner. | none |
| status_ids | identifier[] | An array of Opportunity status IDs. The possible values are 0, 1, 2, 3, for “Open”, “Won”, “Lost”, and “Abandoned”, respectively. | none |
| pipeline_ids | identifier[] | An array of pipeline IDs. | none |
| pipeline_stage_ids | identifier[] | An array of pipeline stage IDs. | none |
| primary_contact_ids | identifier[] | An array of primary contact IDs. | none |
| priority_ids | identifier[] | An array of priority IDs. | none |
| customer_source_ids | identifier[] | An array of customer source IDs, or -2 for no customer source. | none |
| loss_reason_ids | identifier[] | An array of loss reason IDs, or -2 for no loss reason. | none |
| company_ids | identifier[] | An array of company IDs. | none |
| tags | string[] | Filter Opportunities to those that match at least one of the tags specified. | none |
| followed | number | 1: followed, 2: not followed | none |
| minimum_monetary_value | number | The minimum monetary value Opportunities must have. | none |
| maximum_monetary_value | number | The maximum monetary value Opportunities must have. | none |
| minimum_interaction_count | number | The minimum number of interactions Opportunities must have had. | none |
| maximum_interaction_count | number | The maximum number of interactions Opportunities must have had. | none |
| minimum_close_date | timestamp | The Unix timestamp of the earliest close date. | none |
| maximum_close_date | timestamp | The Unix timestamp of the latest close date. | 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_stage_change_date | timestamp | The Unix timestamp of the earliest date of a state change. | none |
| maximum_stage_change_date | timestamp | The Unix timestamp of the latest date of a state change. | none |
| minimum_created_date | timestamp | The Unix timestamp of the earliest date Opportunities are created. | none |
| maximum_created_date | timestamp | The Unix timestamp of the latest date Opportunities are created. | none |
| minimum_modified_date | timestamp | The Unix timestamp of the earliest date Opportunities are modified. | none |
| maximum_modified_date | timestamp | The Unix timestamp of the latest date Opportunities are modified. | none |
Footnotes:
Request body¶
{
"page_size": 25,
"sort_by": "name"
}Example Requests¶
Opportunities Search¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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\"
}"[
{
"id": 2827699,
"name": "25 Office Chairs (sample)",
"assignee_id": null,
"close_date": "1/16/2017",
"company_id": 9607580,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 331242,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 213214,
"pipeline_is_revenue": false,
"pipeline_stage_id": 987793,
"pipeline_type": "opportunity",
"primary_contact_id": null,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_value": 75000,
"win_probability": 40,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1483988829,
"date_modified": 1489018922,
"custom_fields": [
{
"custom_field_definition_id": 126240,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
},
{
"custom_field_definition_id": 100764,
"value": null
}
]
},
{
"id": 2827700,
"name": "500 Keyboards (sample)",
"assignee_id": null,
"close_date": "1/14/2017",
"company_id": 9607581,
"company_name": "Sabre Inc (sample)",
"customer_source_id": null,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 213214,
"pipeline_is_revenue": false,
"pipeline_stage_id": 987791,
"pipeline_type": "opportunity",
"primary_contact_id": null,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_value": 50000,
"win_probability": 10,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1483988829,
"date_modified": 1496943803,
"custom_fields": [
{
"custom_field_definition_id": 126240,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
},
{
"custom_field_definition_id": 100764,
"value": null
}
]
},
{
"id": 2827698,
"name": "8 New Copy Machines (sample)",
"assignee_id": null,
"close_date": "1/23/2017",
"company_id": 9607580,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 331241,
"details": "This is an update",
"loss_reason_id": null,
"pipeline_id": 213214,
"pipeline_is_revenue": false,
"pipeline_stage_id": 987790,
"pipeline_type": "opportunity",
"primary_contact_id": null,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_value": 250000,
"win_probability": 5,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1483988829,
"date_modified": 1496776255,
"custom_fields": [
{
"custom_field_definition_id": 126240,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
},
{
"custom_field_definition_id": 100764,
"value": null
}
]
},
{
"id": 3826510,
"name": "Demo Opportunity",
"assignee_id": null,
"close_date": null,
"company_id": null,
"company_name": null,
"customer_source_id": null,
"details": null,
"loss_reason_id": null,
"pipeline_id": 213214,
"pipeline_is_revenue": false,
"pipeline_stage_id": 987790,
"pipeline_type": "opportunity",
"primary_contact_id": null,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_value": null,
"win_probability": 5,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1490114507,
"date_modified": 1496700017,
"custom_fields": [
{
"custom_field_definition_id": 126240,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
},
{
"custom_field_definition_id": 100764,
"value": null
}
]
},
{
"id": 4417020,
"name": "Demo Project",
"assignee_id": null,
"close_date": null,
"company_id": 13349319,
"company_name": "Noemail",
"customer_source_id": null,
"details": "",
"loss_reason_id": null,
"pipeline_id": 213214,
"pipeline_is_revenue": false,
"pipeline_stage_id": 987790,
"pipeline_type": "opportunity",
"primary_contact_id": 27140359,
"priority": null,
"status": "Open",
"tags": [],
"interaction_count": 1,
"monetary_value": 1000,
"win_probability": 0,
"date_last_contacted": 1496703593,
"leads_converted_from": [
{
"lead_id": 11393303,
"converted_timestamp": 1496694264
}
],
"date_lead_created": 1496692663,
"date_created": 1496694264,
"date_modified": 1496943309,
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": "Text fields are 255 chars or less!"
},
{
"custom_field_definition_id": 103481,
"value": "Text area fields can have long text content"
},
{
"custom_field_definition_id": 126240,
"value": null
}
]
},
{
"id": 2841646,
"name": "ejfpvoiewjrvoierjvoierv",
"assignee_id": 137658,
"close_date": "2/10/2017",
"company_id": null,
"company_name": null,
"customer_source_id": null,
"details": null,
"loss_reason_id": null,
"pipeline_id": 213214,
"pipeline_is_revenue": false,
"pipeline_stage_id": 987790,
"pipeline_type": "opportunity",
"primary_contact_id": null,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_value": null,
"win_probability": 5,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1484096886,
"date_modified": 1489018921,
"custom_fields": [
{
"custom_field_definition_id": 126240,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
},
{
"custom_field_definition_id": 100764,
"value": null
}
]
},
{
"id": 4418567,
"name": "New Demo Opportunity",
"assignee_id": null,
"close_date": null,
"company_id": 13349319,
"company_name": "Noemail",
"customer_source_id": null,
"details": null,
"loss_reason_id": null,
"pipeline_id": 213214,
"pipeline_is_revenue": false,
"pipeline_stage_id": 987790,
"pipeline_type": "opportunity",
"primary_contact_id": 27140359,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 1,
"monetary_value": null,
"win_probability": 5,
"date_last_contacted": 1496703593,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1496713840,
"date_modified": 1496943302,
"custom_fields": [
{
"custom_field_definition_id": 126240,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
},
{
"custom_field_definition_id": 100764,
"value": null
}
]
},
{
"id": 4956209,
"name": "New Demo Opportunity",
"assignee_id": null,
"close_date": null,
"company_id": 13349319,
"company_name": "Noemail",
"customer_source_id": 331242,
"details": null,
"loss_reason_id": null,
"pipeline_id": 213214,
"pipeline_is_revenue": false,
"pipeline_stage_id": 987790,
"pipeline_type": "opportunity",
"primary_contact_id": 27140359,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_value": null,
"win_probability": 5,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1502158599,
"date_modified": 1502158600,
"custom_fields": [
{
"custom_field_definition_id": 126240,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
},
{
"custom_field_definition_id": 100764,
"value": null
}
]
}
]Search by Assignee Ids¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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": 4,
"name": "25 Office Chairs (sample)",
"assignee_id": 2,
"close_date": "1/15/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 6,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 13,
"pipeline_type": "opportunity",
"primary_contact_id": 5,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 75000,
"win_probability": 40,
"date_stage_changed": 1515434869,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434869,
"date_modified": 1516310945,
"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
}
]
}
]Search by Priorities¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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\",
\"priorities\": [\"High\"]
}"[
{
"id": 3,
"name": "8 New Copy Machines (sample)",
"assignee_id": null,
"close_date": "1/22/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 5,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 10,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "High",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 250000,
"win_probability": 5,
"date_stage_changed": 1515434867,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434867,
"date_modified": 1516673603,
"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
}
]
}
]Search by Date Stage Changed¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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_stage_change_date\": 1515434869,
\"maximum_stage_change_date\": 1515434869
}"[
{
"id": 4,
"name": "25 Office Chairs (sample)",
"assignee_id": 2,
"close_date": "1/15/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 6,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 13,
"pipeline_type": "opportunity",
"primary_contact_id": 5,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 2,
"monetary_unit": "USD",
"monetary_value": 75000,
"win_probability": 40,
"date_stage_changed": 1515434869,
"date_last_contacted": 1516737600,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434869,
"date_modified": 1516737667,
"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
}
]
}
]Search by Value¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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\": 75000,
\"maximum_monetary_value\": 75000
}"[
{
"id": 4,
"name": "25 Office Chairs (sample)",
"assignee_id": 2,
"close_date": "1/15/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 6,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 13,
"pipeline_type": "opportunity",
"primary_contact_id": 5,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 75000,
"win_probability": 40,
"date_stage_changed": 1515434869,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434869,
"date_modified": 1516310945,
"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
}
]
}
]Search by Pipeline Stage Ids¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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\",
\"pipeline_stage_ids\": [13]
}"[
{
"id": 4,
"name": "25 Office Chairs (sample)",
"assignee_id": 2,
"close_date": "1/15/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 6,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 13,
"pipeline_type": "opportunity",
"primary_contact_id": 5,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 75000,
"win_probability": 40,
"date_stage_changed": 1515434869,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434869,
"date_modified": 1516310945,
"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
}
]
}
]Search by Primary Contact Ids¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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\",
\"primary_contact_ids\": [25]
}"[
{
"id": 32,
"name": "Julie Perrota Deal",
"assignee_id": 6,
"close_date": "12/14/2024",
"company_id": 27,
"company_name": "Julie Perrotta Company",
"customer_source_id": 16,
"details": null,
"loss_reason_id": null,
"pipeline_id": 6,
"pipeline_is_revenue": false,
"pipeline_stage_id": 15,
"pipeline_type": "opportunity",
"primary_contact_id": 25,
"priority": "Low",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 5000.0,
"converted_unit": "USD",
"converted_value": 5000.0,
"win_probability": 65,
"date_stage_changed": 1730142605,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1729622418,
"date_modified": 1730309445,
"custom_fields": []
}
]Search by Statuses¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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\",
\"statuses\": [\"Open\"]
}"[
{
"id": 4,
"name": "25 Office Chairs (sample)",
"assignee_id": 2,
"close_date": "1/15/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 6,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 13,
"pipeline_type": "opportunity",
"primary_contact_id": 5,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 75000,
"win_probability": 40,
"date_stage_changed": 1515434869,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434869,
"date_modified": 1516310945,
"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
}
]
},
{
"id": 5,
"name": "500 Keyboards (sample)",
"assignee_id": null,
"close_date": "1/13/2018",
"company_id": 4,
"company_name": "Sabre Inc (sample)",
"customer_source_id": null,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 11,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 50000,
"win_probability": 10,
"date_stage_changed": 1515434870,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434870,
"date_modified": 1516673290,
"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
}
]
},
{
"id": 3,
"name": "8 New Copy Machines (sample)",
"assignee_id": null,
"close_date": "1/22/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 5,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 10,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 250000,
"win_probability": 5,
"date_stage_changed": 1515434867,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434867,
"date_modified": 1516673297,
"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
}
]
},
{
"id": 6,
"name": "Sell stuff",
"assignee_id": null,
"close_date": "2/8/2018",
"company_id": 4,
"company_name": "Sabre Inc (sample)",
"customer_source_id": null,
"details": null,
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 10,
"pipeline_type": "opportunity",
"primary_contact_id": 6,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": null,
"win_probability": 5,
"date_stage_changed": 1515458602,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515458602,
"date_modified": 1516673280,
"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
}
]
}
]Search by Company Ids¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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_ids\": [3]
}"[
{
"id": 4,
"name": "25 Office Chairs (sample)",
"assignee_id": 2,
"close_date": "1/15/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 6,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 13,
"pipeline_type": "opportunity",
"primary_contact_id": 5,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 75000,
"win_probability": 40,
"date_stage_changed": 1515434869,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434869,
"date_modified": 1516310945,
"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
}
]
},
{
"id": 3,
"name": "8 New Copy Machines (sample)",
"assignee_id": null,
"close_date": "1/22/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 5,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 10,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "High",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 250000,
"win_probability": 5,
"date_stage_changed": 1515434867,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434867,
"date_modified": 1516673603,
"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
}
]
}
]Search by Loss Reason Ids¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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\",
\"loss_reason_ids\": [-2]
}"[
{
"id": 4,
"name": "25 Office Chairs (sample)",
"assignee_id": 2,
"close_date": "1/15/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 6,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 13,
"pipeline_type": "opportunity",
"primary_contact_id": 5,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 75000,
"win_probability": 40,
"date_stage_changed": 1515434869,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434869,
"date_modified": 1516310945,
"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
}
]
},
{
"id": 5,
"name": "500 Keyboards (sample)",
"assignee_id": null,
"close_date": "1/13/2018",
"company_id": 4,
"company_name": "Sabre Inc (sample)",
"customer_source_id": null,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 11,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 50000,
"win_probability": 10,
"date_stage_changed": 1515434870,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434870,
"date_modified": 1516673290,
"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
}
]
},
{
"id": 3,
"name": "8 New Copy Machines (sample)",
"assignee_id": null,
"close_date": "1/22/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 5,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 10,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "High",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 250000,
"win_probability": 5,
"date_stage_changed": 1515434867,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434867,
"date_modified": 1516673603,
"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
}
]
},
{
"id": 6,
"name": "Sell stuff",
"assignee_id": null,
"close_date": "2/8/2018",
"company_id": 4,
"company_name": "Sabre Inc (sample)",
"customer_source_id": 5,
"details": null,
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 10,
"pipeline_type": "opportunity",
"primary_contact_id": 6,
"priority": "None",
"status": "Lost",
"tags": [],
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": null,
"win_probability": 5,
"date_stage_changed": 1515458602,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515458602,
"date_modified": 1516733449,
"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
}
]
}
]curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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\"]
}
}"[
{
"id": 5,
"name": "500 Keyboards (sample)",
"assignee_id": null,
"close_date": "1/13/2018",
"company_id": 4,
"company_name": "Sabre Inc (sample)",
"customer_source_id": null,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 11,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "None",
"status": "Open",
"tags": [
"tag1"
],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 50000,
"win_probability": 10,
"date_stage_changed": 1515434870,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434870,
"date_modified": 1516736568,
"custom_fields": [
{
"custom_field_definition_id": 5,
"value": 6
},
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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
}
]
}
]List Opportunities in Groups of 200¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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": 4,
"name": "25 Office Chairs (sample)",
"assignee_id": 2,
"close_date": "1/15/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 6,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 13,
"pipeline_type": "opportunity",
"primary_contact_id": 5,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 2,
"monetary_unit": "USD",
"monetary_value": 75000,
"win_probability": 40,
"date_stage_changed": 1515434869,
"date_last_contacted": 1516737600,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434869,
"date_modified": 1516820005,
"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
}
]
},
{
"id": 5,
"name": "500 Keyboards (sample)",
"assignee_id": null,
"close_date": "1/13/2018",
"company_id": 4,
"company_name": "Sabre Inc (sample)",
"customer_source_id": null,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 11,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "None",
"status": "Open",
"tags": [
"tag1"
],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 50000,
"win_probability": 10,
"date_stage_changed": 1515434870,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434870,
"date_modified": 1516736568,
"custom_fields": [
{
"custom_field_definition_id": 5,
"value": 6
},
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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
}
]
},
{
"id": 3,
"name": "8 New Copy Machines (sample)",
"assignee_id": null,
"close_date": "1/22/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 5,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 10,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "High",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 250000,
"win_probability": 5,
"date_stage_changed": 1515434867,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434867,
"date_modified": 1516736704,
"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
}
]
},
{
"id": 6,
"name": "Sell stuff",
"assignee_id": null,
"close_date": "2/8/2018",
"company_id": 4,
"company_name": "Sabre Inc (sample)",
"customer_source_id": 5,
"details": null,
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 10,
"pipeline_type": "opportunity",
"primary_contact_id": 6,
"priority": "None",
"status": "Lost",
"tags": [],
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": null,
"win_probability": 5,
"date_stage_changed": 1515458602,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515458602,
"date_modified": 1516736700,
"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
}
]
}
]Search by Close Date¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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_close_date\": 1515801600,
\"maximum_close_date\": 1515888000
}"[
{
"id": 5,
"name": "500 Keyboards (sample)",
"assignee_id": null,
"close_date": "1/13/2018",
"company_id": 4,
"company_name": "Sabre Inc (sample)",
"customer_source_id": null,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 11,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 50000,
"win_probability": 10,
"date_stage_changed": 1515434870,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434870,
"date_modified": 1516673290,
"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
}
]
}
]Search by Date Last Interacted¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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\": 1515434870,
\"maximum_interaction_date\": 1516737685
}"[
{
"id": 4,
"name": "25 Office Chairs (sample)",
"assignee_id": 2,
"close_date": "1/15/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 6,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 13,
"pipeline_type": "opportunity",
"primary_contact_id": 5,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 2,
"monetary_unit": "USD",
"monetary_value": 75000,
"win_probability": 40,
"date_stage_changed": 1515434869,
"date_last_contacted": 1516737600,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434869,
"date_modified": 1516737667,
"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
}
]
}
]Search by Name¶
This example demonstrates how to search Opportunities by name. The name has to be an exact match for the search to be successful.
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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\": \"25 Office Chairs (sample)\"
}"[
{
"id": 4,
"name": "25 Office Chairs (sample)",
"assignee_id": 2,
"close_date": "1/15/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 6,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 13,
"pipeline_type": "opportunity",
"primary_contact_id": 5,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 75000,
"win_probability": 40,
"date_stage_changed": 1515434869,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434869,
"date_modified": 1516310945,
"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
}
]
}
]Search by Followed¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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": 5,
"name": "500 Keyboards (sample)",
"assignee_id": null,
"close_date": "1/13/2018",
"company_id": 4,
"company_name": "Sabre Inc (sample)",
"customer_source_id": null,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 11,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "None",
"status": "Open",
"tags": [
"tag1"
],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 50000,
"win_probability": 10,
"date_stage_changed": 1515434870,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434870,
"date_modified": 1516736568,
"custom_fields": [
{
"custom_field_definition_id": 5,
"value": 6
},
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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
}
]
}
]Search by Interaction Count¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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
}"[
{
"id": 4,
"name": "25 Office Chairs (sample)",
"assignee_id": 2,
"close_date": "1/15/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 6,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 13,
"pipeline_type": "opportunity",
"primary_contact_id": 5,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 2,
"monetary_unit": "USD",
"monetary_value": 75000,
"win_probability": 40,
"date_stage_changed": 1515434869,
"date_last_contacted": 1516737600,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434869,
"date_modified": 1516737667,
"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
}
]
}
]Search by Customer Source Ids¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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\": [5]
}"[
{
"id": 3,
"name": "8 New Copy Machines (sample)",
"assignee_id": null,
"close_date": "1/22/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 5,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 10,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "High",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 250000,
"win_probability": 5,
"date_stage_changed": 1515434867,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434867,
"date_modified": 1516673603,
"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
}
]
},
{
"id": 6,
"name": "Sell stuff",
"assignee_id": null,
"close_date": "2/8/2018",
"company_id": 4,
"company_name": "Sabre Inc (sample)",
"customer_source_id": 5,
"details": null,
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 10,
"pipeline_type": "opportunity",
"primary_contact_id": 6,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": null,
"win_probability": 5,
"date_stage_changed": 1515458602,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515458602,
"date_modified": 1516674120,
"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
}
]
}
]Search by Created Date¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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\": 1515434870,
\"maximum_created_date\": 1515434870
}"[
{
"id": 5,
"name": "500 Keyboards (sample)",
"assignee_id": null,
"close_date": "1/13/2018",
"company_id": 4,
"company_name": "Sabre Inc (sample)",
"customer_source_id": null,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 11,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 50000,
"win_probability": 10,
"date_stage_changed": 1515434870,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434870,
"date_modified": 1516673290,
"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
}
]
}
]Search by Custom Date Field¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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\": 1515744000
}]
}"[
{
"id": 5,
"name": "500 Keyboards (sample)",
"assignee_id": null,
"close_date": "1/13/2018",
"company_id": 4,
"company_name": "Sabre Inc (sample)",
"customer_source_id": null,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 11,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "None",
"status": "Open",
"tags": [
"tag1"
],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 50000,
"win_probability": 10,
"date_stage_changed": 1515434870,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434870,
"date_modified": 1516736568,
"custom_fields": [
{
"custom_field_definition_id": 5,
"value": 6
},
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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
}
]
}
]Search by Custom Multi-Select Dropdown¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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": 5,
"name": "500 Keyboards (sample)",
"assignee_id": null,
"close_date": "1/13/2018",
"company_id": 4,
"company_name": "Sabre Inc (sample)",
"customer_source_id": null,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 11,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "None",
"status": "Open",
"tags": [
"tag1"
],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 50000,
"win_probability": 10,
"date_stage_changed": 1515434870,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434870,
"date_modified": 1516736568,
"custom_fields": [
{
"custom_field_definition_id": 5,
"value": 6
},
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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
}
]
}
]Search by Multi-Select Dropdown Set to Empty¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities/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": 4,
"name": "25 Office Chairs (sample)",
"assignee_id": 2,
"close_date": "1/15/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 6,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 13,
"pipeline_type": "opportunity",
"primary_contact_id": 5,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 75000,
"win_probability": 40,
"date_stage_changed": 1515434869,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434869,
"date_modified": 1516736722,
"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
}
]
},
{
"id": 3,
"name": "8 New Copy Machines (sample)",
"assignee_id": null,
"close_date": "1/22/2018",
"company_id": 3,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 5,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 10,
"pipeline_type": "opportunity",
"primary_contact_id": 3,
"priority": "High",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_unit": "USD",
"monetary_value": 250000,
"win_probability": 5,
"date_stage_changed": 1515434867,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515434867,
"date_modified": 1516736704,
"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
}
]
},
{
"id": 6,
"name": "Sell stuff",
"assignee_id": null,
"close_date": "2/8/2018",
"company_id": 4,
"company_name": "Sabre Inc (sample)",
"customer_source_id": 5,
"details": null,
"loss_reason_id": null,
"pipeline_id": 3,
"pipeline_is_revenue": false,
"pipeline_stage_id": 10,
"pipeline_type": "opportunity",
"primary_contact_id": 6,
"priority": "None",
"status": "Lost",
"tags": [],
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": null,
"win_probability": 5,
"date_stage_changed": 1515458602,
"date_last_contacted": null,
"leads_converted_from": [],
"date_lead_created": null,
"date_created": 1515458602,
"date_modified": 1516736700,
"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
}
]
}
]URL: https://developer.copper.com/leads/fetch-a-lead-by-id.html
Fetch a Lead by ID¶
GET https://api.copper.com/developer_api/v1/leads/{{example_lead_id}}
Note that this endpoint is eligible to return computed custom field values, click here for more information.
Example Requests¶
Sample Lead¶
curl --location --request GET "https://api.copper.com/developer_api/v1/leads/{{example_lead_id}}" \
--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"{
"id": 8894157,
"name": "Test Lead",
"prefix": null,
"first_name": "Test",
"last_name": "Lead",
"middle_name": null,
"suffix": null,
"address": {
"street": "301 Howard St Ste 600",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "US"
},
"assignee_id": 137658,
"company_name": "Lead's Company",
"customer_source_id": 331241,
"details": "This is a demo description",
"email": {
"email": "address@workemail.com",
"category": "work"
},
"monetary_value": 100,
"socials": [
{
"url": "facebook.com/test_lead",
"category": "facebook"
}
],
"status": "New",
"status_id": 208231,
"tags": [
"tag 1",
"tag 2"
],
"title": "Title",
"websites": [
{
"url": "www.workwebsite.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "415-999-4321",
"category": "mobile"
},
{
"number": "415-555-1234",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"date_created": 1489018784,
"date_modified": 1489173601
}URL: https://developer.copper.com/leads/create-a-new-lead.html
Create a New Lead¶
POST https://api.copper.com/developer_api/v1/leads
Note that this endpoint is eligible to return computed custom field values, click here for more information.
Request body¶
{
"name":"My Lead",
"email": {
"email":"mylead@noemail.com",
"category":"work"
},
"phone_numbers": [
{
"number":"415-123-45678",
"category":"mobile"
}
],
"address": {
"street": "123 Main Street",
"city": "Savannah",
"state": "Georgia",
"postal_code": "31410",
"country": "United States"
},
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": "Text fields are 255 chars or less!"
},
{
"custom_field_definition_id": 103481,
"value": "Text area fields can have long text content"
}
],
"customer_source_id":331242
}Example Requests¶
Create new Lead¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads" \
--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 "{
\"name\":\"My Lead\",
\"email\": {
\"email\":\"mylead@noemail.com\",
\"category\":\"work\"
},
\"phone_numbers\": [
{
\"number\":\"415-123-45678\",
\"category\":\"mobile\"
}
],
\"custom_fields\": [
{
\"custom_field_definition_id\": 100764,
\"value\": \"Text fields are 255 chars or less!\"
},
{
\"custom_field_definition_id\": 103481,
\"value\": \"Text area fields can have long text content\"
}
],
\"customer_source_id\":331242
}"{
"id": 13244480,
"name": "My Lead",
"prefix": null,
"first_name": "My",
"last_name": "Lead",
"middle_name": null,
"suffix": null,
"address": null,
"assignee_id": null,
"company_name": null,
"customer_source_id": 331242,
"details": null,
"email": {
"email": "mylead@noemail.com",
"category": "work"
},
"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": "Text fields are 255 chars or less!"
},
{
"custom_field_definition_id": 103481,
"value": "Text area fields can have long text content"
},
{
"custom_field_definition_id": 128735,
"value": null
}
],
"date_created": 1502158444,
"date_modified": 1502158444,
"date_last_contacted": null
}URL: https://developer.copper.com/leads/update-a-lead.html
Update a Lead¶
PUT https://api.copper.com/developer_api/v1/leads/{{example_lead_id}}
Updates are only applied to fields explicitly specified in the request body. For example, if an update request is made with an empty
body, no updates will be made. To remove the value from a field, the request body must specify the target field value as ‘null’.
Request body¶
{
"details": "This is an update",
"custom_fields": [
{
"custom_field_definition_id": 184997,
"value": [ 262644, 262645 ]
}
]
}Note that this endpoint is eligible to return computed custom field values, click here for more information.
Example Requests¶
Update a Lead¶
curl --location --request PUT "https://api.copper.com/developer_api/v1/leads/{{example_lead_id}}" \
--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 "{
\"details\":\"This is an update\",
\"custom_fields\": [
{
\"custom_field_definition_id\": 184997,
\"value\": [262644,262645]
}
]
}"{
"id": 8894157,
"name": "Test Lead",
"prefix": null,
"first_name": "Test",
"last_name": "Lead",
"middle_name": null,
"suffix": null,
"address": {
"street": "301 Howard St Ste 600",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "US"
},
"assignee_id": 137658,
"company_name": "Lead's Company",
"customer_source_id": 331241,
"details": "This is an update",
"email": {
"email": "address@workemail.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": 100,
"socials": [
{
"url": "facebook.com/test_lead",
"category": "facebook"
}
],
"status": "New",
"status_id": 208231,
"tags": [
"tag 1",
"tag 2"
],
"title": "Title",
"websites": [
{
"url": "www.workwebsite.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "415-999-4321",
"category": "mobile"
},
{
"number": "415-555-1234",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": "A Text Value"
},
{
"custom_field_definition_id": 128735,
"value": 1511942400
},
{
"custom_field_definition_id": 184997,
"value": [
262644,
262645
]
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"date_created": 1489018784,
"date_modified": 1513976942,
"date_last_contacted": null
}URL: https://developer.copper.com/leads/upsert-a-lead.html
UPSERT a Lead¶
PUT https://api.copper.com/developer_api/v1/leads/upsert
Note that this endpoint is eligible to return computed custom field values, click here for more information.
Functionality¶
“Upsert” (update + insert) will atomically do the following:
Match Criteria¶
The supported match criteria are:
To match on a Custom Field, the corresponding Custom Field Definition must be available on Leads and included in filters. (These settings
may be viewed and edited in the web application via System Settings -> Custom Fields.)
Match Outcomes¶
Match outcomes are handled as follows:
Request body¶
{
"properties": {
"name": "My Lead",
"email": {
"email": "mylead@gmail.test",
"category": "work"
}
},
"match": {
"field_name": "email",
"field_value": "mylead@gmail.test"
}
}Example Requests¶
UPSERT a Lead¶
curl --location --request PUT "https://api.copper.com/developer_api/v1/leads/upsert" \
--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 "{
\"properties\": {
\"name\": \"My Lead\",
\"email\": {
\"email\": \"mylead@gmail.test\",
\"category\": \"work\"
}
},
\"match\": {
\"field_name\": \"email\",
\"field_value\": \"mylead@gmail.test\"
}
}"{
"id": 8982702,
"name": "My Lead",
"prefix": null,
"first_name": "My",
"last_name": "Lead",
"middle_name": null,
"suffix": null,
"address": null,
"assignee_id": null,
"company_name": null,
"customer_source_id": null,
"details": null,
"email": {
"email": "mylead@gmail.test",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"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
},
{
"custom_field_definition_id": 128735,
"value": null
}
],
"date_created": 1489531171,
"date_modified": 1512006056,
"date_last_contacted": null
}URL: https://developer.copper.com/leads/upsert-a-lead-by-custom-field.html
UPSERT a Lead (by custom field)¶
PUT https://api.copper.com/developer_api/v1/leads/upsert
Note that this endpoint is eligible to return computed custom field values, click here for more information.
Request body¶
{
"properties": {
"name": "My Lead",
"email": {
"email": "mylead@gmail.test",
"category": "work"
}
},
"match": {
"field_name": "custom",
"field_value": {
"custom_field_definition_id": 100764,
"value" : "Some text"
}
}
}Example Requests¶
UPSERT a Leads¶
curl --location --request PUT "https://api.copper.com/developer_api/v1/leads/upsert" \
--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 "{
\"properties\": {
\"name\": \"My Lead\",
\"email\": {
\"email\": \"mylead@gmail.test\",
\"category\": \"work\"
}
},
\"match\": {
\"field_name\": \"custom\",
\"field_value\": {
\"custom_field_definition_id\": 178384,
\"value\" : 1
}
}
}"{
"id": 8982702,
"name": "My Lead",
"prefix": null,
"first_name": "My",
"last_name": "Lead",
"middle_name": null,
"suffix": null,
"address": null,
"assignee_id": null,
"company_name": null,
"customer_source_id": null,
"details": null,
"email": {
"email": "mylead@gmail.test",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"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
},
{
"custom_field_definition_id": 128735,
"value": null
}
],
"date_created": 1489531171,
"date_modified": 1512006056,
"date_last_contacted": null
}URL: https://developer.copper.com/leads/convert-a-lead.html
Convert a Lead¶
POST https://api.copper.com/developer_api/v1/leads/{{example_leadconvert_id}}/convert
This request creates a Person record from a Lead record. Optionally, a Company and an Opportunity record can be created as well in the same process. The Lead record is removed after it has been converted.
Note that this endpoint is eligible to return computed custom field values, click here for more information.
| Field | Type | Details |
| person | object | Details about the Person to be created by the Lead conversion. Valid fields are name, contact_type_id, and assignee_id. |
| company | object | Details about the Company to which the newly created Person will belong. Valid fields are id or name, and they are mutually exclusive. If a Company id is specified, the new Person will belong to that Company. If the name of an existing Company is specified, the new Person will belong to that Company. If a new name is specified, a new Company will be created with that name, and the new Person will belong to that Company. If you explicitly supply an empty string (“”) for the company name, then no Company will be created. By default, fuzzy matching will return a list of candidate companies. An optional Boolean field “exact_match” can be specified if the exact company name is known. |
| opportunity | object | Details about the Opportunity to be created by the Lead conversion. Valid fields are name, pipeline_id, pipeline_stage_id, monetary_value, and assignee_id. If unspecified, no Opportunity will be created. If pipeline_stage_id is unspecified, it will default to the first stage in the pipeline. |
Request body¶
{
"details":{
"person":{
"name":"John Doe"
},
"opportunity":{
"name":"Demo Project",
"pipeline_id":213214,
"pipeline_stage_id":12345,
"monetary_value":1000
}
}
}Example Requests¶
Lead Conversion¶
curl --location --request POST "https://api.copper.com/developer_api/v1/leads/{{example_leadconvert_id}}/convert" \
--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 "{
\"details\":{
\"person\":{
\"name\":\"John Doe\"
},
\"opportunity\":{
\"name\":\"Demo Project\",
\"pipeline_id\":213214,
\"pipeline_stage_id\":12345,
\"monetary_value\":1000
}
}
}"{
"person": {
"id": 27140359,
"name": "My Contact",
"prefix": null,
"first_name": "My",
"middle_name": null,
"last_name": "Contact",
"suffix": null,
"address": null,
"assignee_id": null,
"company_id": 13349319,
"company_name": "Noemail",
"contact_type_id": 451492,
"details": null,
"emails": [
{
"email": "mylead@noemail.com",
"category": "work"
}
],
"phone_numbers": [],
"socials": [],
"tags": [],
"title": null,
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": "Text fields are 255 chars or less!"
},
{
"custom_field_definition_id": 103481,
"value": "Text area fields can have long text content"
}
],
"date_created": 1490045010,
"date_modified": 1496694264,
"interaction_count": 0
},
"company": {
"id": 13349319,
"name": "Noemail",
"address": null,
"assignee_id": 137658,
"contact_type_id": 451490,
"details": null,
"email_domain": "noemail.com",
"phone_numbers": [],
"socials": [],
"tags": [],
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": "Text fields are 255 chars or less!"
},
{
"custom_field_definition_id": 103481,
"value": "Text area fields can have long text content"
}
],
"interaction_count": 0,
"date_created": 1496694264,
"date_modified": 1496694264
},
"opportunity": {
"id": 4417020,
"name": "Demo Project",
"assignee_id": null,
"close_date": null,
"company_id": 13349319,
"company_name": "Noemail",
"customer_source_id": null,
"details": "",
"loss_reason_id": null,
"pipeline_id": 213214,
"pipeline_stage_id": 987790,
"primary_contact_id": 27140359,
"priority": null,
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_value": 1000,
"win_probability": 0,
"date_created": 1496694264,
"date_modified": 1496694264,
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": "Text fields are 255 chars or less!"
},
{
"custom_field_definition_id": 103481,
"value": "Text area fields can have long text content"
}
]
}
}URL: https://developer.copper.com/leads/list-leads-search.html
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:
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
}
]URL: https://developer.copper.com/custom-fields/general/search-entity-leads-people-etc-by-custom-field.html
Search Entity (Leads, People, etc) by Custom Field¶
POST https://api.copper.com/developer_api/v1/{{entity_name_in_plural}}/search
Custom fields are available for each of the entities (Leads, People, Companies, Opportunities, Projects, and Tasks). Custom field types include: Text Field, Text Area, Dropdown, Date, Checkbox, Number Field, URL, Percentage, Currency, and Multi-Select Dropdown. Text fields are not searchable at this point. The table below summarizes the behavior of each of these fields.
| Field | Type | Search for Empty Value? | Any, All, None Options |
| Dropdown | number array | Yes | No |
| Date | number range | No | No |
| Checkbox | boolean | No | No |
| Number Field | numeric | No | No |
| Percentage | numeric range | No | No |
| Currency | number range | No | No |
| Multi-Select Dropdown | number array | Yes | Yes |
Except for text-related fields, each custom field can be searched via the dev API search endpoint for any of the entities. For Leads, this would be the endpoint /leads/search.
Dropdown and Multi-Select Dropdown fields have the additional option of searching for records where dropdown and multi-select dropdown fields are empty. This can be accomplished by adding an additional field: { “allow_empty”: true }. Searching by Multi-select dropdown also allows searching if any, all, or none of the dropdown options are to be searched. These options can be used together.
Examples of searching for each of the searchable fields can be found under the dropdown menu on the right. Examples given are for Leads and can be easily interchanged with any other entity.
Request Body¶
{
"page_size": 25,
"sort_by": "name"
}Example Requests¶
Search 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 "{
\"custom_fields\": [
{
\"custom_field_definition_id\": 4,
\"minimum_value\": 1518595200,
\"maximum_value\": 1518596200
}
]
}"[
{
"id": 2,
"name": "Jim Halpert (sample)",
"prefix": null,
"first_name": "Jim Halpert (sample)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Scranton",
"state": "PA",
"postal_code": "18503",
"country": null
},
"assignee_id": null,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 1,
"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": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 1,
"tags": [
"sample"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 1,
"value": "Blah"
},
{
"custom_field_definition_id": 2,
"value": "blah blah blah"
},
{
"custom_field_definition_id": 3,
"value": 1
},
{
"custom_field_definition_id": 4,
"value": 1518595200
},
{
"custom_field_definition_id": 5,
"value": true
},
{
"custom_field_definition_id": 6,
"value": 42.0
},
{
"custom_field_definition_id": 7,
"value": "http://blah.com"
},
{
"custom_field_definition_id": 8,
"value": 50
},
{
"custom_field_definition_id": 9,
"value": 1000.0
},
{
"custom_field_definition_id": 10,
"value": [
3
]
}
],
"date_created": 1518656437,
"date_modified": 1518657195,
"date_last_contacted": null
}
]Search Custom Percentage 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 "{
\"custom_fields\": [
{
\"custom_field_definition_id\": 8,
\"minimum_value\": 1,
\"maximum_value\": 50
}
]
}"[
{
"id": 2,
"name": "Jim Halpert (sample)",
"prefix": null,
"first_name": "Jim Halpert (sample)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Scranton",
"state": "PA",
"postal_code": "18503",
"country": null
},
"assignee_id": null,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 1,
"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": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 1,
"tags": [
"sample"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 1,
"value": "Blah"
},
{
"custom_field_definition_id": 2,
"value": "blah blah blah"
},
{
"custom_field_definition_id": 3,
"value": 1
},
{
"custom_field_definition_id": 4,
"value": 1518595200
},
{
"custom_field_definition_id": 5,
"value": true
},
{
"custom_field_definition_id": 6,
"value": 42.0
},
{
"custom_field_definition_id": 7,
"value": "http://blah.com"
},
{
"custom_field_definition_id": 8,
"value": 50
},
{
"custom_field_definition_id": 9,
"value": 1000.0
},
{
"custom_field_definition_id": 10,
"value": [
3
]
}
],
"date_created": 1518656437,
"date_modified": 1518657195,
"date_last_contacted": null
}
]Search Custom Multi-Select Dropdown 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 "{
\"custom_fields\": [
{
\"custom_field_definition_id\": 10,
\"value\": [3]
}
]
}"[
{
"id": 2,
"name": "Jim Halpert (sample)",
"prefix": null,
"first_name": "Jim Halpert (sample)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Scranton",
"state": "PA",
"postal_code": "18503",
"country": null
},
"assignee_id": null,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 1,
"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": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 1,
"tags": [
"sample"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 1,
"value": "Blah"
},
{
"custom_field_definition_id": 2,
"value": "blah blah blah"
},
{
"custom_field_definition_id": 3,
"value": 1
},
{
"custom_field_definition_id": 4,
"value": 1518595200
},
{
"custom_field_definition_id": 5,
"value": true
},
{
"custom_field_definition_id": 6,
"value": 42.0
},
{
"custom_field_definition_id": 7,
"value": "http://blah.com"
},
{
"custom_field_definition_id": 8,
"value": 50
},
{
"custom_field_definition_id": 9,
"value": 1000.0
},
{
"custom_field_definition_id": 10,
"value": [
3
]
}
],
"date_created": 1518656437,
"date_modified": 1518657195,
"date_last_contacted": null
}
]Search Custom Dropdown 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 "{
\"custom_fields\": [
{
\"custom_field_definition_id\": 3,
\"value\": [1]
}
]
}"[
{
"id": 2,
"name": "Jim Halpert (sample)",
"prefix": null,
"first_name": "Jim Halpert (sample)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Scranton",
"state": "PA",
"postal_code": "18503",
"country": null
},
"assignee_id": null,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 1,
"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": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 1,
"tags": [
"sample"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 1,
"value": "Blah"
},
{
"custom_field_definition_id": 2,
"value": "blah blah blah"
},
{
"custom_field_definition_id": 3,
"value": 1
},
{
"custom_field_definition_id": 4,
"value": 1518595200
},
{
"custom_field_definition_id": 5,
"value": true
},
{
"custom_field_definition_id": 6,
"value": 42.0
},
{
"custom_field_definition_id": 7,
"value": "http://blah.com"
},
{
"custom_field_definition_id": 8,
"value": 50
},
{
"custom_field_definition_id": 9,
"value": 1000.0
},
{
"custom_field_definition_id": 10,
"value": [
3
]
}
],
"date_created": 1518656437,
"date_modified": 1518657195,
"date_last_contacted": null
}
]Search Custom Currency 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 "{
\"custom_fields\": [
{
\"custom_field_definition_id\": 9,
\"minimum_value\": 500,
\"maximum_value\": 2000
}
]
}"[
{
"id": 2,
"name": "Jim Halpert (sample)",
"prefix": null,
"first_name": "Jim Halpert (sample)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Scranton",
"state": "PA",
"postal_code": "18503",
"country": null
},
"assignee_id": null,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 1,
"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": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 1,
"tags": [
"sample"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 1,
"value": "Blah"
},
{
"custom_field_definition_id": 2,
"value": "blah blah blah"
},
{
"custom_field_definition_id": 3,
"value": 1
},
{
"custom_field_definition_id": 4,
"value": 1518595200
},
{
"custom_field_definition_id": 5,
"value": true
},
{
"custom_field_definition_id": 6,
"value": 42.0
},
{
"custom_field_definition_id": 7,
"value": "http://blah.com"
},
{
"custom_field_definition_id": 8,
"value": 50
},
{
"custom_field_definition_id": 9,
"value": 1000.0
},
{
"custom_field_definition_id": 10,
"value": [
3
]
}
],
"date_created": 1518656437,
"date_modified": 1518657195,
"date_last_contacted": null
}
]Search Custom Dropdown Field for Empty 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 "{
\"custom_fields\": [
{
\"custom_field_definition_id\": 3,
\"allow_empty\": true
}
]
}"[
{
"id": 1,
"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": 1,
"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": "New",
"status_id": 1,
"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": 1,
"value": null
},
{
"custom_field_definition_id": 9,
"value": null
},
{
"custom_field_definition_id": 4,
"value": null
},
{
"custom_field_definition_id": 6,
"value": null
},
{
"custom_field_definition_id": 10,
"value": []
},
{
"custom_field_definition_id": 2,
"value": null
},
{
"custom_field_definition_id": 8,
"value": null
},
{
"custom_field_definition_id": 7,
"value": null
},
{
"custom_field_definition_id": 5,
"value": false
},
{
"custom_field_definition_id": 3,
"value": null
}
],
"date_created": 1518656436,
"date_modified": 1518656436,
"date_last_contacted": null
}
]Search Custom Multi-Select Dropdown Field for Both Set Value and Empty 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 "{
\"custom_fields\": [
{
\"custom_field_definition_id\": 10,
\"value\": [3],
\"allow_empty\": true
}
]
}"[
{
"id": 2,
"name": "Jim Halpert (sample)",
"prefix": null,
"first_name": "Jim Halpert (sample)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Scranton",
"state": "PA",
"postal_code": "18503",
"country": null
},
"assignee_id": null,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 1,
"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": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 1,
"tags": [
"sample"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 1,
"value": "Blah"
},
{
"custom_field_definition_id": 2,
"value": "blah blah blah"
},
{
"custom_field_definition_id": 3,
"value": 1
},
{
"custom_field_definition_id": 4,
"value": 1518595200
},
{
"custom_field_definition_id": 5,
"value": true
},
{
"custom_field_definition_id": 6,
"value": 42.0
},
{
"custom_field_definition_id": 7,
"value": "http://blah.com"
},
{
"custom_field_definition_id": 8,
"value": 50
},
{
"custom_field_definition_id": 9,
"value": 1000.0
},
{
"custom_field_definition_id": 10,
"value": [
3
]
}
],
"date_created": 1518656437,
"date_modified": 1518657195,
"date_last_contacted": null
},
{
"id": 1,
"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": 1,
"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": "New",
"status_id": 1,
"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": 1,
"value": null
},
{
"custom_field_definition_id": 9,
"value": null
},
{
"custom_field_definition_id": 4,
"value": null
},
{
"custom_field_definition_id": 6,
"value": null
},
{
"custom_field_definition_id": 10,
"value": []
},
{
"custom_field_definition_id": 2,
"value": null
},
{
"custom_field_definition_id": 8,
"value": null
},
{
"custom_field_definition_id": 7,
"value": null
},
{
"custom_field_definition_id": 5,
"value": false
},
{
"custom_field_definition_id": 3,
"value": null
}
],
"date_created": 1518656436,
"date_modified": 1518656436,
"date_last_contacted": null
}
]Search Custom Number 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 "{
\"custom_fields\": [
{
\"custom_field_definition_id\": 6,
\"minimum_value\": 40,
\"maximum_value\": 50
}
]
}"[
{
"id": 2,
"name": "Jim Halpert (sample)",
"prefix": null,
"first_name": "Jim Halpert (sample)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Scranton",
"state": "PA",
"postal_code": "18503",
"country": null
},
"assignee_id": null,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 1,
"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": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 1,
"tags": [
"sample"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 1,
"value": "Blah"
},
{
"custom_field_definition_id": 2,
"value": "blah blah blah"
},
{
"custom_field_definition_id": 3,
"value": 1
},
{
"custom_field_definition_id": 4,
"value": 1518595200
},
{
"custom_field_definition_id": 5,
"value": true
},
{
"custom_field_definition_id": 6,
"value": 42.0
},
{
"custom_field_definition_id": 7,
"value": "http://blah.com"
},
{
"custom_field_definition_id": 8,
"value": 50
},
{
"custom_field_definition_id": 9,
"value": 1000.0
},
{
"custom_field_definition_id": 10,
"value": [
3
]
}
],
"date_created": 1518656437,
"date_modified": 1518657195,
"date_last_contacted": null
}
]Search Custom Checkbox 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 "{
\"custom_fields\": [
{
\"custom_field_definition_id\": 5,
\"value\": true
}
]
}"[
{
"id": 2,
"name": "Jim Halpert (sample)",
"prefix": null,
"first_name": "Jim Halpert (sample)",
"last_name": null,
"middle_name": null,
"suffix": null,
"address": {
"street": "213 West Main St",
"city": "Scranton",
"state": "PA",
"postal_code": "18503",
"country": null
},
"assignee_id": null,
"company_name": "Dunder Mifflin, Inc.",
"customer_source_id": 1,
"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": "jim@dundermifflin.com",
"category": "work"
},
"interaction_count": 0,
"monetary_unit": null,
"monetary_value": 2500,
"socials": [],
"status": "New",
"status_id": 1,
"tags": [
"sample"
],
"title": "Manager",
"websites": [
{
"url": "http://www.dundermifflin.com",
"category": "work"
}
],
"phone_numbers": [
{
"number": "5104447778",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 1,
"value": "Blah"
},
{
"custom_field_definition_id": 2,
"value": "blah blah blah"
},
{
"custom_field_definition_id": 3,
"value": 1
},
{
"custom_field_definition_id": 4,
"value": 1518595200
},
{
"custom_field_definition_id": 5,
"value": true
},
{
"custom_field_definition_id": 6,
"value": 42.0
},
{
"custom_field_definition_id": 7,
"value": "http://blah.com"
},
{
"custom_field_definition_id": 8,
"value": 50
},
{
"custom_field_definition_id": 9,
"value": 1000.0
},
{
"custom_field_definition_id": 10,
"value": [
3
]
}
],
"date_created": 1518656437,
"date_modified": 1518657195,
"date_last_contacted": null
}
]URL: https://developer.copper.com/account-and-users/list-users.html
List Users¶
POST https://api.copper.com/developer_api/v1/users/search
Parameters¶
You can include the following parameters in a search request.
| Field | Type | Details | Default |
| Required Parameters | | | |
| — | | | |
| Optional Parameters | | | |
| 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 |
Example¶
List of Users¶
curl --location --request POST "https://api.copper.com/developer_api/v1/users/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_number":1,
"page_size": 200
}'[
{
"id": 137658,
"name": "John Doe",
"email": "johndoe@copper.com"
},
{
"id": 159258,
"name": "Jane Smith",
"email": "janesmith@copper.com"
}
]URL: https://developer.copper.com/leads/list-lead-statuses.html
List Lead Statuses¶
GET https://api.copper.com/developer_api/v1/lead_statuses
Lead statuses are values that can be assigned to a Lead entity to indicate where they are in the qualification process.
| Field | Type | Description |
| id | identifier | Unique identifier for the status |
| name | string | The name of the lead status |
| order | number | The position of the value in the list when displayed in the app |
| is_default | boolean | Indicates whether this value is selected as default when creating a new record |
Example Requests¶
Lead Statuses¶
curl --location --request GET "https://api.copper.com/developer_api/v1/lead_statuses" \
--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"[
{
"id": 208231,
"name": "New",
"order": 1,
"is_default": true
},
{
"id": 208232,
"name": "Open",
"order": 2,
"is_default": false
},
{
"id": 208233,
"name": "Unqualified",
"order": 3,
"is_default": false
},
{
"id": 208234,
"name": "Junk",
"order": 4,
"is_default": false
}
]URL: https://developer.copper.com/leads/list-customer-sources.html
List Customer Sources¶
GET https://api.copper.com/developer_api/v1/customer_sources
Customer Sources identify where a particular Lead or Opportunity came from. The Customer Sources API allows you to retrieve the
list of Customer Sources associated with your Copper account.
| Field | Type | Details |
| id | identifier | Unique* identifier for the Customer Source. |
| name | string | Label for the Customer Source definition. |
Example Requests¶
Customer Sources¶
curl --location --request GET "https://api.copper.com/developer_api/v1/customer_sources" \
--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"[
{
"id": 331240,
"name": "Email"
},
{
"id": 331241,
"name": "Cold Call"
},
{
"id": 331242,
"name": "Advertising"
}
]URL: https://developer.copper.com/companies/fetch-a-company-by-id.html
Fetch a Company by ID¶
GET https://api.copper.com/developer_api/v1/companies/{{example_company_id}}
Example Requests¶
Company¶
curl --location --request GET "https://api.copper.com/developer_api/v1/companies/{{example_company_id}}" \
--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" \{
"id": 9607580,
"name": "Dunder Mifflin (sample)",
"address": {
"street": "213 West Main Street",
"city": "Scranton",
"state": "PA",
"postal_code": "18501",
"country": ""
},
"assignee_id": null,
"contact_type_id": null,
"details": "Keywords: Dunder Mifflin, Dunder Mifflin Infinity, Dunder Mifflin Paper, Dunder Mifflin Scranton, Dunder-mifflin, Dunder-mifflin Paper, Dunder-mifflin Scranton, Dundermifflin, NBC, NBC.com, Office 360, Ryan Howard, Scranton Office Supplies, The Office 360, The Office Tv, The Office Tv Series, The Office Tv Show",
"email_domain": "dundermifflin.com",
"phone_numbers": [
{
"number": "4153554776",
"category": "work"
}
],
"primary_contact_id": 27140359,
"socials": [],
"tags": [],
"websites": [
{
"url": "http://www.dundermifflin.com/index.shtml",
"category": "work"
},
{
"url": "https://www.nbcstore.com/shop-by-show/the-office.html?shop_by_theme=7",
"category": "work"
},
{
"url": "http://dundermifflin.com",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"interaction_count": 0,
"date_created": 1483988828,
"date_modified": 1489018922
}URL: https://developer.copper.com/companies/create-a-new-company.html
Create a New Company¶
POST https://api.copper.com/developer_api/v1/companies
Request body¶
{
"name":"Demo Company",
"address": {
"street": "123 Main Street",
"city": "Savannah",
"state": "Georgia",
"postal_code": "31410",
"country": "United States"
},
"email_domain":"democompany.com",
"details":"This is a demo company",
"phone_numbers": [
{
"number":"415-123-45678",
"category":"work"
}
],
"primary_contact_id": 27140359
}Example Requests¶
Create company¶
curl --location --request POST "https://api.copper.com/developer_api/v1/companies" \
--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 "{
\"name\":\"Demo Company\",
\"address\": {
\"street\":\"123 Main St\",
\"city\": \"San Francisco\",
\"state\":\"CA\",
\"postal_code\": \"94105\"
},
\"email_domain\":\"democompany.com\",
\"details\":\"This is a demo company\",
\"phone_numbers\": [
{
\"number\":\"415-123-45678\",
\"category\":\"work\"
}
],
\"primary_contact_id\": \"27140359\"
}"{
"id": 13358412,
"name": "Demo Company",
"address": {
"street": "123 Main St",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": null
},
"assignee_id": null,
"contact_type_id": null,
"details": "This is a demo company",
"email_domain": "democompany.com",
"phone_numbers": [
{
"number": "415-123-45678",
"category": "work"
}
],
"primary_contact_id": 27140359,
"socials": [],
"tags": [],
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"interaction_count": 0,
"date_created": 1496707930,
"date_modified": 1496707930
}URL: https://developer.copper.com/companies/update-a-company.html
Update a Company¶
PUT https://api.copper.com/developer_api/v1/companies/{{example_company_id}}
Updates are only applied to fields explicitly specified in the request body. For example, if an update request is made with an
empty body, no updates will be made. To remove the value from a field, the request body must specify the target field value
as ‘null’.
Request body¶
{
"details":"This is an update"
}Example Requests¶
Update Company¶
curl --location --request PUT "https://api.copper.com/developer_api/v1/companies/{{example_company_id}}" \
--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 "{
\"details\":\"This is an update\"
}"{
"id": 9607580,
"name": "Dunder Mifflin (sample)",
"address": {
"street": "213 West Main Street",
"city": "Scranton",
"state": "PA",
"postal_code": "18501",
"country": ""
},
"assignee_id": null,
"contact_type_id": null,
"details": "This is an update",
"email_domain": "dundermifflin.com",
"phone_numbers": [
{
"number": "4153554776",
"category": "work"
}
],
"primary_contact_id": 27140359,
"socials": [],
"tags": [],
"websites": [
{
"url": "http://www.dundermifflin.com/index.shtml",
"category": "work"
},
{
"url": "https://www.nbcstore.com/shop-by-show/the-office.html?shop_by_theme=7",
"category": "work"
},
{
"url": "http://dundermifflin.com",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"interaction_count": 0,
"date_created": 1483988828,
"date_modified": 1496708712
}URL: https://developer.copper.com/companies/list-companies-search.html
List Companies (Search)¶
POST https://api.copper.com/developer_api/v1/companies/search
The /search endpoint provides the ability to list Companies and sort the results by certain parameters. When multiple ciriteria
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 Companies, these
fields are: city, state, postal_code, tags, custom dropdown, custom multi-select fields.
For an example of how this works, see Search Companies 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 under Custom Fields folder.
Note that this endpoint is eligible to return computed custom field values, click here for more information.
| Field | Type | Details | Default |
| ids | identifier[] | An array of Company 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). | date_modified |
| sort_direction | string | The direction in which to sort the results. Possible values are: asc or desc. | asc |
| name | string | Full name of the Company to search for. | none |
| phone_number | string | Phone number of the Company to search for. | none |
| email_domains | string | Email domains of the Company to search for. | none |
| contact_type_ids | number[] | The contact type Ids to search for (see footnote 2). | none |
| assignee_ids | number[] | The ids of Users that Company must be owned by, or -2 for Company with no owner. | none |
| city | string | The city in which Company must be located. | none |
| state | string | The state or province in which Company must be located. | none |
| postal_code | string | The postal code in which Company must be located. | none |
| country | string | The two character country code where Company must be located. | none |
| tags | string[] | Filter Companies to those that match at least one of the tags specified. | none |
| socials | string[] | Filter Companies 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 Company must be. | none |
| minimum_interaction_count | number | The minimum number of interactions Company must have had. | none |
| maximum_interaction_count | number | The maximum number of interactions Company 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 Company are created. | none |
| maximum_created_date | timestamp | The Unix timestamp of the latest date Company are created. | none |
Footnote:
Request body¶
{
"page_size": 25,
"sort_by": "name"
}Example Requests¶
Companies Search¶
curl --location --request POST "https://api.copper.com/developer_api/v1/companies/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\"
}"[
{
"id": 13358412,
"name": "Demo Company",
"address": {
"street": "123 Main St",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": null
},
"assignee_id": null,
"contact_type_id": null,
"details": "This is a demo company",
"email_domain": "democompany.com",
"phone_numbers": [
{
"number": "415-123-45678",
"category": "work"
}
],
"primary_contact_id": 27140361,
"socials": [],
"tags": [],
"websites": [
{
"url": "http://democompany.com",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"interaction_count": 0,
"date_created": 1496707930,
"date_modified": 1496707932
},
{
"id": 9607580,
"name": "Dunder Mifflin (sample)",
"address": {
"street": "213 West Main Street",
"city": "Scranton",
"state": "PA",
"postal_code": "18501",
"country": ""
},
"assignee_id": null,
"contact_type_id": null,
"details": "This is an update",
"email_domain": "dundermifflin.com",
"phone_numbers": [
{
"number": "4153554776",
"category": "work"
}
],
"primary_contact_id": 27140362,
"socials": [],
"tags": [],
"websites": [
{
"url": "http://www.dundermifflin.com/index.shtml",
"category": "work"
},
{
"url": "https://www.nbcstore.com/shop-by-show/the-office.html?shop_by_theme=7",
"category": "work"
},
{
"url": "http://dundermifflin.com",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"interaction_count": 0,
"date_created": 1483988828,
"date_modified": 1496708712
},
{
"id": 13349319,
"name": "Noemail",
"address": null,
"assignee_id": 137658,
"contact_type_id": 451490,
"details": null,
"email_domain": "noemail.com",
"phone_numbers": [],
"primary_contact_id": 27140359,
"socials": [],
"tags": [],
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": "Text fields are 255 chars or less!"
},
{
"custom_field_definition_id": 103481,
"value": "Text area fields can have long text content"
}
],
"interaction_count": 0,
"date_created": 1496694264,
"date_modified": 1496694270
},
{
"id": 9607579,
"name": "ProsperWorks",
"address": {
"street": "221 Main Street Suite 1350",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": ""
},
"assignee_id": null,
"contact_type_id": 451493,
"details": "Overview: ProsperWorks is the world's first zero input CRM. Designed specifically for Google Apps, ProsperWorks helps companies sell more faster by identifying, organizing and tracking sales opportunities right in Gmail, Calendar and Google Drive. By removing the need for data entry, salespeople can focus on developing business and managers can finally have accurate forecasting with real time activity tracking. ProsperWorks was founded by Jon Lee, Kelly Cheng and Andrew Hu with the commitment to empower small business sales and marketing. Jon was Founder/CEO of three big data companies that solved optimization problems in advertising, gaming and photo sharing. Each company realized successful exits. The team also includes the leaders in engineering and product from Facebook Mobile, BaseCRM and Salesforce. ProsperWorks has raised $10 million in funding from True Ventures, Bloomberg Beta, Crunchfund and other high-profile angel investors. ProsperWorks is based in San Francisco, CA.\n\nApprox. Number of Employees: 30\n\nFounded: 2011\n\nKeywords: Automotive, CRM, Finance, Google, Google Apps, Leadership, Management, Podcasting, SAAS, Sales, Small Business",
"email_domain": "prosperworks.com",
"phone_numbers": [
{
"number": "4153554776",
"category": "work"
}
],
"primary_contact_id": 27140363,
"socials": [
{
"url": "https://www.linkedin.com/company/prosperworks-inc-",
"category": "linkedin"
},
{
"url": "https://twitter.com/ProsperWorks",
"category": "twitter"
},
{
"url": "https://www.facebook.com/ProsperWorks",
"category": "facebook"
},
{
"url": "http://klout.com/ProsperWorks",
"category": "klout"
},
{
"url": "https://angel.co/prosperworks",
"category": "other"
},
{
"url": "https://plus.google.com/u/0/103594665195397142807",
"category": "other"
},
{
"url": "http://www.crunchbase.com/organization/prosperworks",
"category": "other"
}
],
"tags": [],
"websites": [
{
"url": "www.prosperworks.com",
"category": "work"
},
{
"url": "https://www.prosperworks.com",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"interaction_count": 0,
"date_created": 1483988828,
"date_modified": 1489018922
},
{
"id": 9607581,
"name": "Sabre Inc (sample)",
"address": {
"street": "543 Washington Ave",
"city": "Philadelphia",
"state": "PA",
"postal_code": "19135",
"country": ""
},
"assignee_id": null,
"contact_type_id": null,
"details": null,
"email_domain": null,
"phone_numbers": [],
"primary_contact_id": 27140364,
"socials": [],
"tags": [],
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"interaction_count": 0,
"date_created": 1483988828,
"date_modified": 1489018922
}
]Search Companies by Email Domains¶
curl --location --request POST "https://api.copper.com/developer_api/v1/companies/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\",
\"email_domains\": [\"dundermifflin.com\"]
}"[
{
"id": 2,
"name": "Dunder Mifflin (sample)",
"address": {
"street": "213 West Main Street",
"city": "Scranton",
"state": "PA",
"postal_code": "18501",
"country": null
},
"assignee_id": null,
"contact_type_id": null,
"details": null,
"email_domain": "dundermifflin.com",
"phone_numbers": [
{
"number": "4153554776",
"category": "work"
}
],
"primary_contact_id": 27140359,
"socials": [],
"tags": [],
"websites": [
{
"url": "http://www.dundermifflin.com/index.shtml",
"category": "work"
}
],
"custom_fields": [],
"interaction_count": 0,
"date_created": 1519852352,
"date_modified": 1519852398
}
]Search Companies by Contact Type Ids¶
curl --location --request POST "https://api.copper.com/developer_api/v1/companies/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\": [6]
}"[
{
"id": 4,
"name": "Sabre Inc (sample)",
"address": {
"street": "543 Washington Ave",
"city": "Philadelphia",
"state": "PA",
"postal_code": "19135",
"country": ""
},
"assignee_id": 2,
"contact_type_id": 6,
"details": null,
"email_domain": null,
"phone_numbers": [],
"primary_contact_id": 27140359,
"socials": [],
"tags": [],
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 8,
"value": null
},
{
"custom_field_definition_id": 11,
"value": null
}
],
"interaction_count": 0,
"date_created": 1515434867,
"date_modified": 1516320789
}
]Search Companies by Custom Date Field¶
curl --location --request POST "https://api.copper.com/developer_api/v1/companies/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": 4,
"name": "Sabre Inc (sample)",
"address": {
"street": "543 Washington Ave",
"city": "Philadelphia",
"state": "PA",
"postal_code": "19135",
"country": "US"
},
"assignee_id": 2,
"contact_type_id": 6,
"details": null,
"email_domain": null,
"phone_numbers": [],
"primary_contact_id": 27140365,
"socials": [],
"tags": [
"tag1"
],
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
}
],
"interaction_count": 0,
"date_created": 1515434867,
"date_modified": 1516324052
}
]Search Companies by Postal Code¶
curl --location --request POST "https://api.copper.com/developer_api/v1/companies/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\": \"18501\"
}"[
{
"id": 3,
"name": "Dunder Mifflin (sample)",
"address": {
"street": "213 West Main Street",
"city": "Scranton",
"state": "PA",
"postal_code": "18501",
"country": "US"
},
"assignee_id": null,
"contact_type_id": 5,
"details": null,
"email_domain": "dundermifflin.com",
"phone_numbers": [
{
"number": "4153554776",
"category": "work"
}
],
"primary_contact_id": 27140356,
"socials": [],
"tags": [],
"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
}
],
"interaction_count": 0,
"date_created": 1515434866,
"date_modified": 1516323758
}
]Search Companies by Last Interaction¶
curl --location --request POST "https://api.copper.com/developer_api/v1/companies/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\": 1516262400,
\"maximum_interaction_date\": 1516313000
}"[
{
"id": 2,
"name": "ProsperWorks",
"address": {
"street": "221 Main Street Suite 1350",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": ""
},
"assignee_id": null,
"contact_type_id": 8,
"details": null,
"email_domain": "prosperworks.com",
"phone_numbers": [
{
"number": "4153554776",
"category": "work"
}
],
"primary_contact_id": 27140367,
"socials": [
{
"url": "https://www.linkedin.com/company/prosperworks-inc-",
"category": "linkedin"
}
],
"tags": [],
"websites": [
{
"url": "www.prosperworks.com",
"category": "work"
},
{
"url": "https://www.prosperworks.com",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 12,
"value": [
9
]
},
{
"custom_field_definition_id": 8,
"value": null
}
],
"interaction_count": 2,
"date_created": 1515434866,
"date_modified": 1516324063
},
{
"id": 4,
"name": "Sabre Inc (sample)",
"address": {
"street": "543 Washington Ave",
"city": "Philadelphia",
"state": "PA",
"postal_code": "19135",
"country": "US"
},
"assignee_id": 2,
"contact_type_id": 6,
"details": null,
"email_domain": null,
"phone_numbers": [],
"primary_contact_id": 27140368,
"socials": [],
"tags": [
"tag1"
],
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
}
],
"interaction_count": 2,
"date_created": 1515434867,
"date_modified": 1516324258
}
]Search Companies by City¶
curl --location --request POST "https://api.copper.com/developer_api/v1/companies/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": 4,
"name": "Sabre Inc (sample)",
"address": {
"street": "543 Washington Ave",
"city": "Philadelphia",
"state": "PA",
"postal_code": "19135",
"country": ""
},
"assignee_id": 2,
"contact_type_id": 6,
"details": null,
"email_domain": null,
"phone_numbers": [],
"primary_contact_id": 27140369,
"socials": [],
"tags": [],
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 8,
"value": null
},
{
"custom_field_definition_id": 11,
"value": null
}
],
"interaction_count": 0,
"date_created": 1515434867,
"date_modified": 1516320789
}
]Search Companies by Socials¶
curl --location --request POST "https://api.copper.com/developer_api/v1/companies/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/sabreinc\"]
}"[
{
"id": 4,
"name": "Sabre Inc (sample)",
"address": {
"street": "543 Washington Ave",
"city": "Philadelphia",
"state": "PA",
"postal_code": "19135",
"country": ""
},
"assignee_id": 2,
"contact_type_id": 6,
"details": null,
"email_domain": null,
"phone_numbers": [],
"primary_contact_id": 27140370,
"socials": [
{
"url": "https://www.linkedin.com/in/sabreinc",
"category": "linkedin"
}
],
"tags": [],
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 8,
"value": null
},
{
"custom_field_definition_id": 11,
"value": null
}
],
"interaction_count": 0,
"date_created": 1515434867,
"date_modified": 1516320789
}
]URL: https://developer.copper.com/opportunities/fetch-an-opportunity-by-id.html
Fetch an Opportunity by ID¶
GET https://api.copper.com/developer_api/v1/opportunities/{{example_opportunity_id}}
Note that this endpoint is eligible to return computed custom field values, click here for more information.
Example Requests¶
Get Opportunity¶
curl --location --request GET "https://api.copper.com/developer_api/v1/opportunities/{{example_opportunity_id}}" \
--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" \{
"id": 2827698,
"name": "8 New Copy Machines (sample)",
"assignee_id": null,
"close_date": "1/23/2017",
"company_id": 9607580,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 331241,
"details": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
"loss_reason_id": null,
"pipeline_id": 213214,
"pipeline_is_revenue": false,
"pipeline_stage_id": 987790,
"pipeline_type": "opportunity",
"primary_contact_id": null,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_value": 250000,
"win_probability": 5,
"date_created": 1483988829,
"date_modified": 1489018922,
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
]
}URL: https://developer.copper.com/opportunities/create-a-new-opportunity.html
Create a New Opportunity¶
POST https://api.copper.com/developer_api/v1/opportunities
Note that this endpoint is eligible to return computed custom field values, click here for more information.
The following fields are required for this request: name, primary_contact_id
Request body¶
{
"name": "New Demo Opportunity",
"primary_contact_id": 27140359,
"customer_source_id":331242
}Example Requests¶
New Opportunity¶
curl --location --request POST "https://api.copper.com/developer_api/v1/opportunities" \
--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 "{
\"name\": \"New Demo Opportunity\",
\"primary_contact_id\": 27140359,
\"customer_source_id\":331242
}"{
"id": 4956209,
"name": "New Demo Opportunity",
"assignee_id": null,
"close_date": null,
"company_id": 13349319,
"company_name": "Noemail",
"customer_source_id": 331242,
"details": null,
"loss_reason_id": null,
"pipeline_id": 213214,
"pipeline_is_revenue": false,
"pipeline_stage_id": 987790,
"pipeline_type": "opportunity",
"primary_contact_id": 27140359,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_value": null,
"win_probability": 5,
"date_last_contacted": null,
"leads_converted_from": [],
"date_created": 1502158599,
"date_modified": 1502158599,
"custom_fields": [
{
"custom_field_definition_id": 126240,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
},
{
"custom_field_definition_id": 100764,
"value": null
}
]
}URL: https://developer.copper.com/opportunities/update-an-opportunity.html
Update an Opportunity¶
PUT https://api.copper.com/developer_api/v1/opportunities/{{example_opportunity_id}}
Note that this endpoint is eligible to return computed custom field values, click here for more information.
Updates are only applied to fields explicitly specified in the request body. For example, if an update request is made with
an empty body, no updates will be made. To remove the value from a field, the request body must specify the target field value
as ‘null’.
Request body¶
{
"details":"This is an update"
}Example Requests¶
Update Opportunity¶
curl --location --request PUT "https://api.copper.com/developer_api/v1/opportunities/{{example_opportunity_id}}" \
--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 "{
\"details\":\"This is an update\"
}"{
"id": 2827698,
"name": "8 New Copy Machines (sample)",
"assignee_id": null,
"close_date": "1/23/2017",
"company_id": 9607580,
"company_name": "Dunder Mifflin (sample)",
"customer_source_id": 331241,
"details": "This is an update",
"loss_reason_id": null,
"pipeline_id": 213214,
"pipeline_is_revenue": false,
"pipeline_stage_id": 987790,
"pipeline_type": "opportunity",
"primary_contact_id": null,
"priority": "None",
"status": "Open",
"tags": [],
"interaction_count": 0,
"monetary_value": 250000,
"win_probability": 5,
"date_created": 1483988829,
"date_modified": 1496776255,
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
]
}URL: https://developer.copper.com/projects/fetch-a-project-by-id.html
Fetch a Project by ID¶
GET https://api.copper.com/developer_api/v1/projects/{{example_project_id}}
Note that this endpoint is eligible to return computed custom field values, click here for more information.
Get project¶
curl --location --request GET "https://api.copper.com/developer_api/v1/projects/{{example_project_id}}" \
--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"{
"id": 144296,
"name": "Customize Your New CRM",
"related_resource": {
"id": 9607579,
"type": "company"
},
"assignee_id": null,
"status": "Open",
"details": "Visit our settings section to discover all the ways you can customize Copper to fit your sales workflow.",
"tags": [],
"custom_fields": [],
"date_created": 1483988830,
"date_modified": 1496712857
}URL: https://developer.copper.com/projects/create-a-new-project.html
Create a New Project¶
POST https://api.copper.com/developer_api/v1/projects
Note that this endpoint is eligible to return computed custom field values, click here for more information.
The following fields are required for this request:
Body¶
{
"name":"New Demo Project"
}Example Requests¶
New Project¶
curl --location --request POST "https://api.copper.com/developer_api/v1/projects" \
--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 "{
\"name\":\"New Demo Project\"
}"{
"id": 208105,
"name": "New Demo Project",
"related_resource": null,
"assignee_id": null,
"status": "Open",
"details": null,
"tags": [],
"custom_fields": [],
"date_created": 1496713867,
"date_modified": 1496713867
}URL: https://developer.copper.com/projects/update-a-project.html
Update a Project¶
PUT https://api.copper.com/developer_api/v1/projects/{{example_project_id}}
Updates are only applied to fields explicitly specified in the request body. For example, if an update request is made with an empty body, no updates will be made. To remove the value from a field, the request body must specify the target field value as ‘null’.
Note that this endpoint is eligible to return computed custom field values, click here for more information.
Body¶
{
"details":"This is an update"
}Example Requests¶
Update Project¶
curl --location --request PUT "https://api.copper.com/developer_api/v1/projects/{{example_project_id}}" \
--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 "{
\"details\":\"This is an update\"
}"{
"id": 144296,
"name": "Customize Your New CRM",
"related_resource": {
"id": 9607579,
"type": "company"
},
"assignee_id": null,
"status": "Open",
"details": "This is an update",
"tags": [],
"custom_fields": [],
"date_created": 1483988830,
"date_modified": 1496776314
}URL: https://developer.copper.com/projects/list-projects-search.html
List Projects (Search)¶
POST https://api.copper.com/developer_api/v1/projects/search
The /search endpoint provides the ability to list records and sort the results by certain parameters. When multiple ciriteria are provided records meeting ALL criteria will be returned (the filtering criteria have an ‘AND’ relationship).
To see examples of search request using the various parameters, click on the Projects 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 Projects, these fields are: tags, custom dropdown, custom multi-select fields. For an example of how this works, see Search Project 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 under Custom Fields folder.
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 Project 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 Opportunity to search for. | none |
| assignee_ids | identifier[] | The ids of Users that Opportunities must be owned by, or -2 for Opportunities with no owner. | none |
| status_ids | identifier[] | An array of Opportunity status IDs. | none |
| tags | string[] | Filter Opportunities to those that match at least one of the tags specified. | none |
| followed | number | 1: followed, 2: not followed | none |
| minimum_created_date | timestamp | The Unix timestamp of the earliest date Opportunities are created. | none |
| maximum_created_date | timestamp | The Unix timestamp of the latest date Opportunities are created. | none |
| minimum_modified_date | timestamp | The Unix timestamp of the earliest date Opportunities are modified. | none |
| maximum_modified_date | timestamp | The Unix timestamp of the latest date Opportunities are modified. | none |
Foonote:
Body¶
{
"page_size": 25,
"sort_by": "name"
}Example Requests¶
List Projects in Groups of 200¶
curl --location --request POST "https://api.copper.com/developer_api/v1/projects/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": 1,
"name": "Customize Your New CRM",
"related_resource": {
"id": 2,
"type": "company"
},
"assignee_id": 2,
"status": "Open",
"details": "Visit our settings section to discover all the ways you can customize Copper to fit your sales workflow.",
"tags": [
"tag1"
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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": 1516819000
},
{
"id": 2,
"name": "Test Project",
"related_resource": null,
"assignee_id": 2,
"status": "Open",
"details": null,
"tags": [],
"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": 1516751006,
"date_modified": 1516751006
}
]Search by Assignee Ids¶
curl --location --request POST "https://api.copper.com/developer_api/v1/projects/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": 1,
"name": "Customize Your New CRM",
"related_resource": {
"id": 2,
"type": "company"
},
"assignee_id": 2,
"status": "Open",
"details": "Visit our settings section to discover all the ways you can customize Copper to fit your sales workflow.",
"tags": [
"tag1"
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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": 1516747365
}
]Projects Search¶
curl --location --request POST "https://api.copper.com/developer_api/v1/projects/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\"
}"[
{
"id": 13358412,
"name": "Demo Company",
"address": {
"street": "123 Main St",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": null
},
"assignee_id": null,
"contact_type_id": null,
"details": "This is a demo company",
"email_domain": "democompany.com",
"phone_numbers": [
{
"number": "415-123-45678",
"category": "work"
}
],
"socials": [],
"tags": [],
"websites": [
{
"url": "http://democompany.com",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"interaction_count": 0,
"date_created": 1496707930,
"date_modified": 1496707932
},
{
"id": 9607580,
"name": "Dunder Mifflin (sample)",
"address": {
"street": "213 West Main Street",
"city": "Scranton",
"state": "PA",
"postal_code": "18501",
"country": ""
},
"assignee_id": null,
"contact_type_id": null,
"details": "This is an update",
"email_domain": "dundermifflin.com",
"phone_numbers": [
{
"number": "4153554776",
"category": "work"
}
],
"socials": [],
"tags": [],
"websites": [
{
"url": "http://www.dundermifflin.com/index.shtml",
"category": "work"
},
{
"url": "https://www.nbcstore.com/shop-by-show/the-office.html?shop_by_theme=7",
"category": "work"
},
{
"url": "http://dundermifflin.com",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"interaction_count": 2,
"date_created": 1483988828,
"date_modified": 1496710807
},
{
"id": 13362547,
"name": "New Demo Opportunity",
"address": null,
"assignee_id": null,
"contact_type_id": null,
"details": null,
"email_domain": null,
"phone_numbers": [],
"socials": [],
"tags": [],
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"interaction_count": 0,
"date_created": 1496713616,
"date_modified": 1496713616
},
{
"id": 13362760,
"name": "New Demo Project",
"address": null,
"assignee_id": null,
"contact_type_id": null,
"details": null,
"email_domain": null,
"phone_numbers": [],
"socials": [],
"tags": [],
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"interaction_count": 0,
"date_created": 1496713797,
"date_modified": 1496713797
},
{
"id": 13349319,
"name": "Noemail",
"address": null,
"assignee_id": 137658,
"contact_type_id": 451490,
"details": null,
"email_domain": "noemail.com",
"phone_numbers": [],
"socials": [],
"tags": [],
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": "Text fields are 255 chars or less!"
},
{
"custom_field_definition_id": 103481,
"value": "Text area fields can have long text content"
}
],
"interaction_count": 0,
"date_created": 1496694264,
"date_modified": 1496713841
},
{
"id": 9607579,
"name": "Copper",
"address": {
"street": "221 Main Street Suite 1350",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": ""
},
"assignee_id": null,
"contact_type_id": 451493,
"details": "Overview: ProsperWorks is the world's first zero input CRM. Designed specifically for Google Apps, ProsperWorks helps companies sell more faster by identifying, organizing and tracking sales opportunities right in Gmail, Calendar and Google Drive. By removing the need for data entry, salespeople can focus on developing business and managers can finally have accurate forecasting with real time activity tracking. ProsperWorks was founded by Jon Lee, Kelly Cheng and Andrew Hu with the commitment to empower small business sales and marketing. Jon was Founder/CEO of three big data companies that solved optimization problems in advertising, gaming and photo sharing. Each company realized successful exits. The team also includes the leaders in engineering and product from Facebook Mobile, BaseCRM and Salesforce. ProsperWorks has raised $10 million in funding from True Ventures, Bloomberg Beta, Crunchfund and other high-profile angel investors. ProsperWorks is based in San Francisco, CA.\n\nApprox. Number of Employees: 30\n\nFounded: 2011\n\nKeywords: Automotive, CRM, Finance, Google, Google Apps, Leadership, Management, Podcasting, SAAS, Sales, Small Business",
"email_domain": "copper.com",
"phone_numbers": [
{
"number": "4153554776",
"category": "work"
}
],
"socials": [
{
"url": "https://www.linkedin.com/company/copper-inc-",
"category": "linkedin"
},
{
"url": "https://twitter.com/Copper",
"category": "twitter"
},
{
"url": "https://www.facebook.com/Copper",
"category": "facebook"
},
{
"url": "http://klout.com/Copper",
"category": "klout"
},
{
"url": "https://angel.co/copper",
"category": "other"
},
{
"url": "https://plus.google.com/u/0/103594665195397142807",
"category": "other"
},
{
"url": "http://www.crunchbase.com/organization/copper",
"category": "other"
}
],
"tags": [],
"websites": [
{
"url": "www.copper.com",
"category": "work"
},
{
"url": "https://www.copper.com",
"category": "work"
}
],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"interaction_count": 0,
"date_created": 1483988828,
"date_modified": 1489018922
},
{
"id": 9607581,
"name": "Sabre Inc (sample)",
"address": {
"street": "543 Washington Ave",
"city": "Philadelphia",
"state": "PA",
"postal_code": "19135",
"country": ""
},
"assignee_id": null,
"contact_type_id": null,
"details": null,
"email_domain": null,
"phone_numbers": [],
"socials": [],
"tags": [],
"websites": [],
"custom_fields": [
{
"custom_field_definition_id": 100764,
"value": null
},
{
"custom_field_definition_id": 103481,
"value": null
}
],
"interaction_count": 0,
"date_created": 1483988828,
"date_modified": 1489018922
}
]Search by Tags¶
curl --location --request POST "https://api.copper.com/developer_api/v1/projects/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\"]
}
}"[
{
"id": 1,
"name": "Customize Your New CRM",
"related_resource": {
"id": 2,
"type": "company"
},
"assignee_id": 2,
"status": "Open",
"details": "Visit our settings section to discover all the ways you can customize Copper to fit your sales workflow.",
"tags": [
"tag1"
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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": 1516747365
}
]Search by Statuses¶
curl --location --request POST "https://api.copper.com/developer_api/v1/projects/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\",
\"statuses\": [\"Open\"]
}"[
{
"id": 1,
"name": "Customize Your New CRM",
"related_resource": {
"id": 2,
"type": "company"
},
"assignee_id": 2,
"status": "Open",
"details": "Visit our settings section to discover all the ways you can customize Copper to fit your sales workflow.",
"tags": [
"tag1"
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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": 1516747365
}
]Search by Custom Multi-Select Dropdown Set to Empty¶
curl --location --request POST "https://api.copper.com/developer_api/v1/projects/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": 2,
"name": "Test Project",
"related_resource": null,
"assignee_id": 2,
"status": "Open",
"details": null,
"tags": [],
"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": 1516751006,
"date_modified": 1516751006
}
]Search by Custom Date Field¶
curl --location --request POST "https://api.copper.com/developer_api/v1/projects/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\": 1515744000
}]
}"[
{
"id": 1,
"name": "Customize Your New CRM",
"related_resource": {
"id": 2,
"type": "company"
},
"assignee_id": 2,
"status": "Open",
"details": "Visit our settings section to discover all the ways you can customize Copper to fit your sales workflow.",
"tags": [
"tag1"
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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": 1516747365
}
]Search by Custom Multi-Select Dropdown¶
curl --location --request POST "https://api.copper.com/developer_api/v1/projects/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": 1,
"name": "Customize Your New CRM",
"related_resource": {
"id": 2,
"type": "company"
},
"assignee_id": 2,
"status": "Open",
"details": "Visit our settings section to discover all the ways you can customize Copper to fit your sales workflow.",
"tags": [
"tag1"
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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": 1516747365
}
]URL: https://developer.copper.com/tasks/fetch-a-task-by-id.html
Fetch a Task by ID¶
GET https://api.copper.com/developer_api/v1/tasks/{{example_task_id}}
Note that this endpoint is eligible to return computed custom field values, click here for more information.
Example Requests¶
Get Task¶
curl --location --request GET "https://api.copper.com/developer_api/v1/tasks/{{example_task_id}}" \
--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"{
"id": 3716920,
"name": "My First Task",
"related_resource": {
"id": 144296,
"type": "project"
},
"assignee_id": 137658,
"due_date": 1496799000,
"reminder_date": null,
"completed_date": null,
"priority": "None",
"status": "Open",
"details": null,
"tags": [],
"custom_fields": [],
"date_created": 1496712856,
"date_modified": 1496712857
}URL: https://developer.copper.com/tasks/create-a-new-task.html
Create a New Task¶
POST https://api.copper.com/developer_api/v1/tasks
Note that this endpoint is eligible to return computed custom field values, click here for more information.
Request body¶
{
"name": "Demo task",
"related_resource": {
"id": 144296,
"type": "project"
},
"assignee_id": 137658,
"due_date": 1496799000,
"reminder_date": null,
"priority": "None",
"status": "Open",
"details": "This needs to be done!",
"tags": [],
"custom_fields": []
}Example Requests¶
Create Task¶
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks" \
--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 "{
\"name\":\"Demo Task\"
}"{
"id": 3726701,
"name": "Demo Task",
"related_resource": {
"id": null,
"type": null
},
"assignee_id": 137658,
"due_date": null,
"reminder_date": null,
"completed_date": null,
"priority": "None",
"status": "Open",
"details": null,
"tags": [],
"custom_fields": [],
"date_created": 1496771985,
"date_modified": 1496771985
}URL: https://developer.copper.com/tasks/update-a-task.html
Update a Task¶
PUT https://api.copper.com/developer_api/v1/tasks/{{example_task_id}}
Updates are only applied to fields explicitly specified in the request body. For example, if an update request is made with an
empty body, no updates will be made. To remove the value from a field, the request body must specify the target field value
as ‘null’.
Note that this endpoint is eligible to return computed custom field values, click here for more information.
Request body¶
{
"details":"This is an update"
}Example Requests¶
Update Task¶
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/{{example_task_id}}" \
--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 '{ "name": "Demo Task" }'{
"id": 3716920,
"name": "My First Task",
"related_resource": {
"id": 144296,
"type": "project"
},
"assignee_id": 137658,
"due_date": 1496799000,
"reminder_date": null,
"completed_date": null,
"priority": "None",
"status": "Open",
"details": "This is an update",
"tags": [],
"custom_fields": [],
"date_created": 1496712856,
"date_modified": 1496776369
}URL: https://developer.copper.com/tasks/list-tasks-search.html
List Tasks (Search)¶
POST https://api.copper.com/developer_api/v1/tasks/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).
Certain fields can be filtered by an empty value, i.e., filter records where the field is not specified. For Tasks, these fields
are: company, opportunity, 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 search by custom fields, see Search Entity by Custom Field.
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 Task 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). | due_date |
| sort_direction | string | The direction in which to sort the results. Possible values are: asc or desc. | asc |
| assignee_ids | identifier[] | The ids of Users that Tasks must be owned by, or -2 for Tasks with no owner. | none |
| opportunity_ids | identifier[] | An array of Opportunity IDs (see footnote 2). | none |
| project_ids | identifier[] | The ids of Projects that Tasks belong to, or -2 for Tasks with no project. | none |
| statuses | string[] | Filter Tasks to statuses specified (“Open”, “Completed”). | none |
| tags | string[] | Filter Tasks to those that match at least one of the tags specified. | none |
| followed | number | 1: followed, 2: not followed | none |
| minimum_due_date | timestamp | The minimum due date Tasks must have. | none |
| maximum_due_date | timestamp | The maximum due date Tasks must have. | none |
| minimum_created_date | timestamp | The Unix timestamp of the earliest date Tasks are created. | none |
| maximum_created_date | timestamp | The Unix timestamp of the latest date Tasks are created. | none |
| minimum_modified_date | timestamp | The minimum modified date Tasks must have. | none |
| maximum_modified_date | timestamp | The maximum modified date Tasks must have. | none |
Footnote:
Request body¶
{
"page_size": 25,
"sort_by": "name"
}Example Requests¶
Tasks Search¶
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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\"
}"[
{
"id": 3726701,
"name": "Demo Task",
"related_resource": {
"id": null,
"type": null
},
"assignee_id": 137658,
"due_date": null,
"reminder_date": null,
"completed_date": null,
"priority": "None",
"status": "Open",
"details": null,
"tags": [],
"custom_fields": [],
"date_created": 1496771985,
"date_modified": 1496771985
},
{
"id": 2277769,
"name": "Download ProsperWorks Mobile App",
"related_resource": {
"id": 9607579,
"type": "company"
},
"assignee_id": null,
"due_date": null,
"reminder_date": null,
"completed_date": null,
"priority": "None",
"status": "Open",
"details": "Visit the Google Play store or the Apple App store to download the ProsperWorks Android or iPhone app.",
"tags": [],
"custom_fields": [],
"date_created": 1483988829,
"date_modified": 1483989349
},
{
"id": 2277771,
"name": "Follow up Call (sample)",
"related_resource": {
"id": null,
"type": null
},
"assignee_id": null,
"due_date": 1483894800,
"reminder_date": null,
"completed_date": null,
"priority": "None",
"status": "Open",
"details": null,
"tags": [],
"custom_fields": [],
"date_created": 1483988829,
"date_modified": 1489018922
},
{
"id": 2277770,
"name": "Follow up on Price Quote (sample)",
"related_resource": {
"id": null,
"type": null
},
"assignee_id": null,
"due_date": 1484067600,
"reminder_date": null,
"completed_date": null,
"priority": "None",
"status": "Open",
"details": null,
"tags": [],
"custom_fields": [],
"date_created": 1483988829,
"date_modified": 1483988829
},
{
"id": 3716920,
"name": "My First Task",
"related_resource": {
"id": 144296,
"type": "project"
},
"assignee_id": 137658,
"due_date": 1496799000,
"reminder_date": null,
"completed_date": null,
"priority": "None",
"status": "Open",
"details": "This is an update",
"tags": [],
"custom_fields": [],
"date_created": 1496712856,
"date_modified": 1496776369
}
]List Tasks in Groups of 200¶
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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": 1,
"name": "Download ProsperWorks Mobile App",
"related_resource": {
"id": 2,
"type": "company"
},
"assignee_id": null,
"due_date": 1516813200,
"reminder_date": null,
"completed_date": null,
"priority": "None",
"status": "Open",
"details": "Visit the Google Play store or the Apple App store to download the ProsperWorks Android or iPhone app.",
"tags": [],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": null
},
{
"custom_field_definition_id": 12,
"value": [
9
]
},
{
"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": 1515434871,
"date_modified": 1516824438,
"custom_activity_type_id": 6
},
{
"id": 3,
"name": "Follow up Call (sample)",
"related_resource": {
"id": 5,
"type": "person"
},
"assignee_id": null,
"due_date": 1515776400,
"reminder_date": null,
"completed_date": null,
"priority": "None",
"status": "Open",
"details": null,
"tags": [],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": null
},
{
"custom_field_definition_id": 12,
"value": [
9
]
},
{
"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": 1515434871,
"date_modified": 1516824426,
"custom_activity_type_id": 6
},
{
"id": 2,
"name": "Follow up on Price Quote (sample)",
"related_resource": {
"id": 4,
"type": "opportunity"
},
"assignee_id": null,
"due_date": 1515517200,
"reminder_date": null,
"completed_date": 1516822940,
"priority": "None",
"status": "Completed",
"details": null,
"tags": [],
"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": 1515434871,
"date_modified": 1516822940,
"custom_activity_type_id": 6
},
{
"id": 6,
"name": "New CRM Task",
"related_resource": {
"id": 1,
"type": "project"
},
"assignee_id": 2,
"due_date": 1516905000,
"reminder_date": null,
"completed_date": null,
"priority": "High",
"status": "Open",
"details": null,
"tags": [
"tag1"
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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": 1516818999,
"date_modified": 1516819000,
"custom_activity_type_id": 6
}
]Search by Assignee Ids¶
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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": "New CRM Task",
"related_resource": {
"id": 1,
"type": "project"
},
"assignee_id": 2,
"due_date": 1516905000,
"reminder_date": null,
"completed_date": null,
"priority": "High",
"status": "Open",
"details": null,
"tags": [
"tag1"
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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": 1516818999,
"date_modified": 1516819000,
"custom_activity_type_id": 6
}
]Search by Tags¶
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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\"]
}
}"[
{
"id": 6,
"name": "New CRM Task",
"related_resource": {
"id": 1,
"type": "project"
},
"assignee_id": 2,
"due_date": 1516905000,
"reminder_date": null,
"completed_date": null,
"priority": "High",
"status": "Open",
"details": null,
"tags": [
"tag1"
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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": 1516818999,
"date_modified": 1516819000,
"custom_activity_type_id": 6
}
]Search by Followed¶
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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": "New CRM Task",
"related_resource": {
"id": 1,
"type": "project"
},
"assignee_id": 2,
"due_date": 1516905000,
"reminder_date": null,
"completed_date": null,
"priority": "High",
"status": "Open",
"details": null,
"tags": [
"tag1"
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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": 1516818999,
"date_modified": 1516819000,
"custom_activity_type_id": 6
}
]Search by Project Ids¶
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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\",
\"project_ids\": [1]
}"[
{
"id": 6,
"name": "New CRM Task",
"related_resource": {
"id": 1,
"type": "project"
},
"assignee_id": 2,
"due_date": 1516905000,
"reminder_date": null,
"completed_date": null,
"priority": "High",
"status": "Open",
"details": null,
"tags": [
"tag1"
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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": 1516818999,
"date_modified": 1516819000,
"custom_activity_type_id": 6
}
]Search by Opportunity Ids¶
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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\",
\"project_ids\": [1]
}"[
{
"id": 2,
"name": "Follow up on Price Quote (sample)",
"related_resource": {
"id": 4,
"type": "opportunity"
},
"assignee_id": null,
"due_date": 1515517200,
"reminder_date": null,
"completed_date": null,
"priority": "None",
"status": "Open",
"details": null,
"tags": [],
"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": 1515434871,
"date_modified": 1516820005,
"custom_activity_type_id": 6
}
]Search by Statuses¶
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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\",
\"statuses\": [\"Completed\"]
}"[
{
"id": 2,
"name": "Follow up on Price Quote (sample)",
"related_resource": {
"id": 4,
"type": "opportunity"
},
"assignee_id": null,
"due_date": 1515517200,
"reminder_date": null,
"completed_date": 1516822940,
"priority": "None",
"status": "Completed",
"details": null,
"tags": [],
"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": 1515434871,
"date_modified": 1516822940,
"custom_activity_type_id": 6
}
]Search by Due Date¶
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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_due_date\": 1515764000,
\"maximum_due_date\": 1515764000
}"[
{
"id": 3,
"name": "Follow up Call (sample)",
"related_resource": {
"id": 5,
"type": "person"
},
"assignee_id": null,
"due_date": 1515776400,
"reminder_date": null,
"completed_date": null,
"priority": "None",
"status": "Open",
"details": null,
"tags": [],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": null
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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": 1515434871,
"date_modified": 1516819079,
"custom_activity_type_id": 6
}
]Search by Custom Date Field¶
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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\": 1515744000
}]
}"[
{
"id": 6,
"name": "New CRM Task",
"related_resource": {
"id": 1,
"type": "project"
},
"assignee_id": 2,
"due_date": 1516905000,
"reminder_date": null,
"completed_date": null,
"priority": "High",
"status": "Open",
"details": null,
"tags": [
"tag1"
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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": 1516818999,
"date_modified": 1516819000,
"custom_activity_type_id": 6
}
]Search by Multi-Select Dropdown¶
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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": "New CRM Task",
"related_resource": {
"id": 1,
"type": "project"
},
"assignee_id": 2,
"due_date": 1516905000,
"reminder_date": null,
"completed_date": null,
"priority": "High",
"status": "Open",
"details": null,
"tags": [
"tag1"
],
"custom_fields": [
{
"custom_field_definition_id": 6,
"value": 1515744000
},
{
"custom_field_definition_id": 12,
"value": [
8
]
},
{
"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": 1516818999,
"date_modified": 1516819000,
"custom_activity_type_id": 6
}
]Search by Multi-Select Dropdown Set to Empty¶
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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": 2,
"name": "Follow up on Price Quote (sample)",
"related_resource": {
"id": 4,
"type": "opportunity"
},
"assignee_id": null,
"due_date": 1515517200,
"reminder_date": null,
"completed_date": 1516822940,
"priority": "None",
"status": "Completed",
"details": null,
"tags": [],
"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": 1515434871,
"date_modified": 1516822940,
"custom_activity_type_id": 6
}
]URL: https://developer.copper.com/webhooks/create-new-subscription.html
Create new subscription¶
POST https://api.copper.com/developer_api/v1/webhooks
Parameters¶
| Field | Type | Details |
| Required Parameters | | |
| target | string | The URL of your webhook endpoint. Must be a valid URL. |
| type | string | The entity type that this subscription is for. Valid values are: “lead”, “person”, “company”, “opportunity”, “project”, “task”. |
| event | string | The event that will trigger notifications for this subscription. Valid values are: “new”, “update”, “delete”. |
| Optional Parameters | | |
| secret | object | Custom key/value pairs that are sent with every notification. Using this secret, your notification endpoint can authenticate the request to make sure it is coming from a trusted source. |
| headers | object | Custom HTTP headers that are sent with every notification. |
| custom_field_computed_values | boolean | If provided and set to true, dropdown custom fields (standard and multi-select) will have their option_ids converted to the option names. |
See the Webhook properties section for more details.
This example shows the creation of a new subscription for events when existing Leads are updated.
Request body¶
{
"target": "https://your.endpoint.here",
"type": "lead",
"event": "update",
"secret": {
"secret": "hook_source",
"key": "copper_notifications"
},
"headers": {
"Authentication": "Bearer token"
},
"custom_field_computed_values": true
}Example Requests¶
Create subscription¶
curl --location --request POST "https://api.copper.com/developer_api/v1/webhooks" \
--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 "{
\"target\": \"https://your.endpoint.here\",
\"type\": \"lead\",
\"event\": \"update\",
\"secret\": {
\"secret\": \"hook_source\",
\"key\": \"copper_notifications\"
},
\"headers\": {
\"Authentication\": \"Bearer token\",
},
\"custom_field_computed_values\": false,
}"{
"id": 17065,
"target": "https://your.endpoint.here",
"type": "lead",
"event": "update",
"secret": {
"secret": "hook_source",
"key": "copper_notifications"
},
"headers": {
"Authentication": "Bearer token"
},
"custom_field_computed_values": false,
"created_at": 1489173015
}{
"success": false,
"status": 422,
"message": "Invalid input: Invalid URI For External Request"
}URL: https://developer.copper.com/webhooks/update-a-subscription.html
Update a subscription¶
PUT https://api.copper.com/developer_api/v1/webhooks/{{subscription_id}}
Parameters¶
Note that all 4 parameters listed below can be optionally provided.
| Field | Type | Details |
| target | string | The URL of your webhook endpoint. Must be a valid URL. |
| secret | object | Custom key/value pairs that are sent with every notification. Using this secret, your notification endpoint can authenticate the request to make sure it is coming from a trusted source. |
| headers | object | Custom HTTP headers that are sent with every notification. |
| custom_field_computed_values | boolean | If provided and set to true, dropdown custom fields (standard and multi-select) will have their option_ids converted to the option names. |
See the Webhook properties section for more details.
This example shows updating an existing subscription.
Request body¶
{
"target": "https://your.endpoint.here",
"secret": {
"secret": "hook_source",
"key": "copper_notifications"
},
"headers": {
"Authentication": "Bearer token"
},
"custom_field_computed_values": true
}Example Requests¶
Update a subscription¶
curl --location --request PUT "https://api.copper.com/developer_api/v1/webhooks/{subscription_id}" \
--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 "{
\"target\": \"https://your.endpoint.here\",
\"secret\": {
\"secret\": \"hook_source\",
\"key\": \"copper_notifications\"
},
\"headers\": {
\"Authentication\": \"Bearer token\"
},
\"custom_field_computed_values\": true,
}"{
"id": 17065,
"target": "https://your.endpoint.here",
"type": "lead",
"event": "update",
"secret": {
"secret": "hook_source",
"key": "copper_notifications"
},
"headers": {
"Authentication": "Bearer token"
},
"custom_field_computed_values": true,
"created_at": 1489173015
}{
"success": false,
"status": 422,
"message": "Invalid input: Invalid URI For External Request"
}URL: https://developer.copper.com/webhooks/notification-example.html
Webhook Notification Example¶
POST https://your.endpoint.here
This example shows the notification request your endpoint will receive when a notification is sent.
There can be 0 or more secret fields shown, depending on the initial webhook configuration. The updated_attributes
field only shows up on an “update” event. The timestamp field is an ISO 8601 timestamp string.
Any custom HTTP headers configured in the headers field are passed along to the webhook endpoint.
Request Body Template¶
{
"ids": [<entity_id_1>, <entity_id_2>, ...],
"type": "<entity_type>",
"event": "<event_type>",
"subscription_id": <subscription_id>,
"secret_field_1": "<string>",
"secret_field_2": "<string>",
"updated_attributes": {
"field_name": [<old_value>, <new_value>]
},
"timestamp": "<string>"
}Request Body with Non-Computed Custom Fields (Default)¶
{
"ids": [
123
],
"secret": "secret",
"key": "key",
"subscription_id": 1,
"event": "update",
"type": "person",
"updated_attributes": {
"custom_fields": {
"1": [
[ 1 ],
[ 1, 2 ]
]
}
},
"timestamp": "2021-12-13T19:18:22.084Z"
}Request Body with Computed Custom Field Values¶
Note: Dropdown/Multi-Select Dropdown Custom Fields are only converted to their name values when the Webhook subscription instance has custom_field_computed_values set to true.
{
"ids": [
123
],
"secret": "secret",
"key": "key",
"subscription_id": 1,
"event": "update",
"type": "person",
"updated_attributes": {
"custom_fields": {
"1": [
[ "Apples"],
[ "Apples", "Bananas" ]
]
}
},
"timestamp": "2021-12-13T19:18:22.084Z"
}URL: https://developer.copper.com/tags/list-tags.html
List Tags¶
GET https://api.copper.com/developer_api/v1/tags
Parameters¶
You can include the following parameters in a request to retrieve a list of all Tags and their entity usage counts.
| Field | Type | Details | Default |
| Required Parameters | | | |
| — | | | |
| Optional Parameters | | | |
| sort_by | string | Can sort by the Tagnameorcount(the total number of times it is used). Only applicable whentag_names_only=false, otherwise it is auto-sorted byname. | name |
| tag_names_only | boolean | When provided, only a list of tag names is provided with no entity usage counts. | false |
| last_tag_value | boolean | Requirestag_names_only=true. Allows you to provide a tag value to get all the tags that occur after it in the alphabetically-sorted list. The max page size is 10000 so you can use this to paginate through large tag lists. | null |
Example¶
List of Tags¶
curl --location --request GET "https://api.copper.com/developer_api/v1/tags?sort_by=name" \
--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"[
{
"name": "Apples",
"count": 5,
"count_people": 1,
"count_leads": 1,
"count_companies": 1,
"count_opportunities": 1,
"count_projects": 1,
"count_tasks": 0
},
{
"name": "Bananas",
"count": 2,
"count_people": 0,
"count_leads": 0,
"count_companies": 1,
"count_opportunities": 0,
"count_projects": 1,
"count_tasks": 0
}
]List of Tags (tag_names_only=true)¶
curl --location --request GET "https://api.copper.com/developer_api/v1/tags?tag_names_only=true" \
--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"[
"Apples",
"Bananas"
]URL: https://developer.copper.com/opportunities/list-pipelines.html
List Pipelines
List Pipelines¶
GET https://api.copper.com/developer_api/v1/pipelines
Pipelines define the stages through which Opportunities move as they progress through your sales process. The Pipelines API
allows you to retrieve the list of Pipelines associated with your Copper account.
| Field | Type | Details |
| id | identifier | Unique identifier for the Pipeline. |
| name | string | The name of the Pipeline. |
| stages | object[] | The list of Pipeline Stages in this Pipelines |
| type | string | The type (“opportunity”, “project”, or “item”) of the Pipeline |
| is_revenue | boolean | The revenue type of the Pipeline |
Example Requests¶
Pipelines¶
curl --location --request GET "https://api.copper.com/developer_api/v1/pipelines" \
--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"[
{
"id": 213214,
"name": "Sales",
"stages": [
{
"id": 987790,
"name": "Qualified",
"win_probability": 5
},
{
"id": 987791,
"name": "Follow-up",
"win_probability": 10
},
{
"id": 987792,
"name": "Presentation",
"win_probability": 20
},
{
"id": 987793,
"name": "Contract Sent",
"win_probability": 40
},
{
"id": 987794,
"name": "Negotiation",
"win_probability": 80
}
],
"type": "opportunity",
"is_revenue": false
},
{
"id": 213215,
"name": "Business Development",
"stages": [
{
"id": 987795,
"name": "First Meeting",
"win_probability": 10
},
{
"id": 987796,
"name": "Partner Meeting",
"win_probability": 25
},
{
"id": 987797,
"name": "Negotiation",
"win_probability": 50
},
{
"id": 987798,
"name": "Term Sheet",
"win_probability": 75
}
],
"type": "opportunity",
"is_revenue": true
}
]URL: https://developer.copper.com/opportunities/overview.html
Opportunities¶
An Opportunity is a potential business deal. The Opportunities API allows you to create, view, delete and update your
Opportunities. You can retrieve individual Opportunities, list all Opportunities, or use search filters to view subsets
of your Opportunities.
Opportunity Properties¶
| Field | Type | Details |
| id | identifier | Unique identifier for the Opportunity. |
| name* | string | The name of the Opportunity. |
| assignee_id | identifier | Unique identifier of the User that will be the owner of the Opportunity. |
| close_date | string | The expected close date of the Opportunity in MM/DD/YYYY or DD/MM/YYYY format. |
| company_id | identifier | The unique identifier of the primary Company with which the Opportunity is associated. |
| company_name | string | The name of the primary Company with which the Opportunity is associated. |
| customer_source_id | identifier | Unique identifier of the Customer Source that generated this Opportunity. |
| details | string | Description of the Opportunity. |
| loss_reason_id | identifier | If the Opportunity’s status is “Lost”, the unique identifier of the loss reason that caused this Opportunity to be lost. |
| monetary_value | number | The monetary value of the Opportunity. |
| pipeline_id | identifier | The unique identifier of the Pipeline in which this Opportunity is. |
| pipeline_is_revenue | boolean | The revenue type of the Pipeline associated with the opportunity. |
| primary_contact_id* | identifier | The unique identifier of the Person who is the primary contact for this Opportunity. |
| priority | string | The priority of the Opportunity. Valid values are: “None”, “Low”, “Medium”, “High”. |
| pipeline_stage_id | identifier | The unique identifier of the Pipeline Stage of the Opportunity. |
| pipeline_type | string | The type of the Pipeline (“opportunity,” “project,” or “item”) associated with the opportunity. |
| status | string | The status of the Opportunity. Valid values are: “Open”, “Won”, “Lost”, “Abandoned”. |
| tags | string[] | An array of the tags associated with the Opportunity, represented as strings. |
| win_probability | number | The expected probability of winning the Opportunity. Valid values are 0-100. |
| date_created | number | A Unix timestamp representing the time at which this Opportunity was created. |
| date_modified | number | A Unix timestamp representing the time at which this Opportunity was last modified. |
| custom_fields[] | object[] | An array of custom field values belonging to the Opportunity. |
| custom_fields[].custom_field_definition_id | identifier | The id of the Custom Field Definition for which this Custom Field stores a value. |
| custom_fields[].value | mixed | The value (number, string, option id, or timestamp) of this Custom Field. |
- indicates a required field
URL: https://developer.copper.com/account-and-users/fetch-api-user.html
Fetch API User¶
GET https://api.copper.com/developer_api/v1/users/me
This endpoint returns details about a the current API user. This user owns the API key (or the OAuth access token) which was used to make the API call.
The response structure is identical to the Fetch User by ID endpoint.
URL: https://developer.copper.com/account-and-users/fetch-user-by-id.html
Fetch User by ID¶
GET https://api.copper.com/developer_api/v1/users/{{example_user_id}}
This endpoint returns details about a specific user within a company.
Special ID “me” can be passed in to obtain the current API user
Response body¶
The response is a JSON object with the following structure:
| Field | Type | Details |
| id | identifier | The User’s unique identifier. |
| name | string | The User’s full name. |
| email | string | The User’s email address. |
| groups | object[] | A list of teams (previously known as “Groups”) that the User belongs to. Each one has the following fields:id: A unique identifier for the Team.name: The name of the Team. |
Example¶
curl --location --request GET "https://api.copper.com/developer_api/v1/users/{{example_user_id}}" \
--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"{
"id": 159258,
"name": "Demo User",
"email": "demouser@example.com",
"groups": [{
"id": 1,
"name": "Sales"
}]
}URL: https://developer.copper.com/introduction/oauth/index.html
Authentication via OAuth2.0¶
1. Introduction¶
You can now access the Copper Developer API via OAuth2.0.
This authentication method is an alternative to Copper’s legacy API Keys,
and is particularly well-suited for third-party integrations looking to create a seamless and secure
link between their users and Copper.
OAuth2.0 offers several advantages over the API Key flow:
2. Prerequisites¶
To use OAuth2.0 with Copper, you must first register your application. This step
protects requests from forgery and keeps your users secure.
To register your application, contact us. You will need to provide
the name and purpose of your application as well as a URL to an HTTPS endpoint that will
handle the secure callback.
You will receive two credentials, client_id and client_secret, required for all authorization flows.
| Parameter | Description |
| client_id | A public alphanumeric string that uniquely identifies your application |
| client_secret | A private alphanumeric secret that verifies your application’s identity |
| redirect_uri | The callback endpoint of your application (e.g.https://yourapp.com/callback) |
3. Authorization Flow Overview¶
Copper implements the commonly-used Authorization Code Grant flow:
For more details, click here.
4. Quickstart Guide¶
Follow our quickstart guide to get up and running quickly.
5. Documentation¶
The detailed Copper authorization flow documentation can be found here.
6. Access Token Management¶
Active OAuth2.0 connections are shown in the Copper user interface, under
Settings â¡ Integrations â¡ Active Integrations. This interface also lets
users revoke their tokens.
Note: account administrators may revoke tokens on behalf of other users
7. Scopes¶
Scopes define specific permissions your application wants to obtain from the user. Currently,
only the developer/v1/all scope is supported, which grants full read and modify access to the authenticated user’s records.
This scope is backward compatible with our legacy API Key authentication.
| Scope | Permissions |
| developer/v1/all | Read and modify user records |
Note: more granular scopes will be added in the future
8. Client Libraries¶
Although it’s entirely feasible to implement the OAuth 2.0 flow through plain REST,
it’s advisable to leverage a library tailored to your chosen application language or framework.
| Language | Library |
| Python | requests-oauthlib |
| Java | Spring Security OAuth |
| JavaScript (Node.js) | simple-oauth2 |
| Ruby | omniauth,oauth2 |
| PHP | league/oauth2-client |
| C# (.NET) | DotNetOpenAuth |
| Go (Golang) | golang/oauth2 |
| Swift (iOS/macOS) | OAuthSwift |
9. Resources¶
URL: https://developer.copper.com/introduction/authentication.html
Authentication¶
There are two ways to access the Copper Developer API: API keys and OAuth2.0.
API Keys are suitable for individual users, while OAuth2.0 is the preferred approach for partner integrations.
API Keys¶
The Dev API uses token based authentication. You have to include the token in the header of every request, along
with the email address of the user who generated the token. Users can hold multiple valid tokens at the same time.
Admins can see all user generated tokens and generate new ones.
To generate an API token, in the Copper web app go to System settings > API Keys and click the ‘GENERATE API KEY’
button. Copper allows you to label each key for its unique purpose. You’ll need to generate an API key to make
an API Request.
OAuth2.0¶
Click here to get started.
URL: https://developer.copper.com/introduction/oauth/flow.html
Copper OAuth2.0 Flow¶
1. Introduction¶
Third-party integrations may take advantage of OAuth 2.0 for the purpose of authorizing and authenticating access to the Copper Developer API. Employing the widely used Authorization Code Grant flow, Copper ensures a seamless and quick authentication process. This approach is particularly well-suited for integrations that cater to existing Copper customers, facilitating the establishment of a robust and secure connection between the integration and Copper.
1.1 Prerequisites¶
1.2 The Authorization Flow¶
The authorization code grant flow involves the following steps:
1.3 Sequence Diagram¶
2. Flow Steps¶
2.1 Authorization Request¶
Endpoint: GET https://app.copper.com/oauth/authorize
Redirect the user to this endpoint to initiate the OAuth2.0 authorization flow.
GET https://app.copper.com/oauth/authorize?response_type=code&client_id={client_id}&redirect_uri={redirect_uri}&scope={scope}&state={state}| Parameter | Description |
| response_type | Must be”code” |
| client_id | Yourclient_id |
| redirect_uri | Yourredirect_uri |
| scope | Requested access scope. Must be”developer/v1/all” |
| state | (optional) Any user-defined metadata to forward to the callback |
Please note that the parameters must be form-encoded (application/x-www-form-urlencoded), similar to how they would appear in an HTML element
2.2 User Authentication¶
At this stage, the user will be prompted to login to their Copper account. If the user is already logged in, this step is skipped.
2.3 Authorization Grant¶
Upon logging in successfully, the user is presented with an authorization screen displaying your app’s name and requested permissions.
The user can grant or deny access by clicking ‘Authorize’ or ‘Deny.’ Afterward, the user is redirected to your app’s redirect_uri via a POST request.
If the authorization was successful, the payload includes a code parameter indicating the authorization code.
In case of denial or errors, the payload contains an error parameter.
| Parameter | Description | Notes |
| code | The authorization code | Only present on success |
| error | Error code | Only present on failure. SeeCommon OAuth2.0 errors |
2.4 Token Request¶
Endpoint: POST https://app.copper.com/oauth/token
After successfully acquiring an authorization code in the previous step, you may proceed to exchange it for an access token.
This access token provides your application with access to the Developer API. Once you have obtained the access token,
you may discard code.
Currently, access tokens do not expire and do not need to be refreshed.
curl -X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=authorization_code" \
-d "code={code}" \
-d "redirect_uri={redirect_uri}" \
-d "client_id={client_id}" \
-d "client_secret={client_secret}" \
https://app.copper.com/oauth/token{
"access_token": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
"token_type": "Bearer",
"scope": "developer/v1/all"
}Request parameters
| Parameter | Description |
| grant_type | Must be”authorization_code” |
| code | Yourcodefrom the previous step |
| redirect_uri | Yourredirect_uri |
| client_id | Yourclient_id |
| client_secret | Yourclient_secret |
Response parameters
| Parameter | Description |
| access_token | The access token |
| token_type | Always”Bearer” |
| scope | The scope granted to the token |
Please note that the parameters must be form-encoded (application/x-www-form-urlencoded), similar to how they would appear in an HTML element
2.5 Access Protected Resources¶
Once you have successfully obtained a valid access_token in the previous step, you can start accessing
the Copper Developer API endpoints. To do so, you simply include the access_token in the Authorization header of your requests.
For example, to fetch the Copper account details of the authenticated user:
curl -H "Authorization: Bearer {access_token}" \
https://api.copper.com/developer_api/v1/account{
"id": 123,
"name": "Company Name",
"primary_timezone": "America/New_York",
"settings": {
"setting_team_permissions_enabled": true,
"setting_enable_leads": true
}
}URL: https://developer.copper.com/account-and-users/fetch-account-details.html
Fetch Account Details¶
GET https://api.copper.com/developer_api/v1/account
Example¶
curl --location --request GET "https://api.copper.com/developer_api/v1/account" \
--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"{
"id": 123,
"name": "Company Name",
"primary_timezone": "America/New_York",
"settings": {
"setting_team_permissions_enabled": true,
"setting_enable_leads": true
}
}URL: https://developer.copper.com/introduction/oauth/quickstart.html
OAuth2.0 Quickstart Guide¶
Introduction¶
This basic example demonstrates how to get started with Copper OAuth2.0.
For a detailed documentation of each step, click here.
Prerequisites¶
Integration¶
Once you have set up your redirect_uri and obtained a client_id and client_secret,
you’re ready to kick off the OAuth2.0 authorization process.
Start by adding a form to your web application that makes a GET request to https://app.copper.com/oauth/authorize:
<form action="https://app.copper.com/oauth/authorize" method="GET">
<input type="hidden" name="response_type" value="code">
<input type="hidden" name="client_id" value="{client_id}">
<input type="hidden" name="redirect_uri" value="{redirect_uri}">
<input type="hidden" name="scope" value="developer/v1/all">
<button type="submit">Integrate with Copper!</button>
</form>When the user submits this form, the authorization process begins.
First, the user will be prompted to log in to their Copper account, followed by a request to authorize your application.
Once the user clicks “Authorize”, they will be redirected back to your application’s redirect_uri via a POST request.
Use the code parameter supplied in the request body, and exchange it for an access token:
curl -X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=authorization_code" \
-d "code={code}" \
-d "redirect_uri={redirect_uri}" \
-d "client_id={client_id}" \
-d "client_secret={client_secret}" \
https://app.copper.com/oauth/tokenA successful response is a JSON document that looks like this:
{
"access_token": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
"token_type": "Bearer",
"scope": "developer/v1/all"
}Extract access_token and store it somewhere safe. You are now ready to make Dev API calls on behalf of the user
by passing in access_token in an Authorization header!
curl -H "Authorization: Bearer {access_token}" \
https://api.copper.com/developer_api/v1/accountURL: https://developer.copper.com/tasks/overview.html
Tasks¶
A Task is a small unit of work which needs to be completed. The Tasks API allows you to create, view, delete and update your
Tasks. You can retrieve individual Tasks, list all Tasks, or use search filters to view subsets of your Tasks.
Task Properties¶
| Field | Type | Details |
| id | identifier | Unique identifier for the Task. |
| name* | string | The name of the Task. |
| related_resource | identifier | The primary related resource for the Task. |
| assignee_id | identifier | Unique identifier of the User that will be the owner of the Task. |
| due_date | number | The date on which the Task is due. |
| reminder_date | number | The date on which to receive a reminder about the Task. |
| completed_date | number | The date on which the Task was completed. This is automatically set when the status changes from Open to Completed, and cannot be set directly. |
| priority | string | The priority of the Task. Valid values are: “None”, “Low”, “Medium”, “High”. |
| status | string | The status of the Task. Valid values are: “Open”, “Completed”. |
| details | string | Description of the Task. |
| tags | list | An array of the tags associated with the Task, represented as strings. |
| custom_fields[] | object[] | An array of custom field values belonging to the Task. |
| custom_fields[].custom_field_definition_id | identifier | The id of the Custom Field Definition for which this Custom Field stores a value. |
| custom_fields[].value | mixed | The value (number, string, option id, or timestamp) of this Custom Field. |
| date_created | timestamp | A Unix timestamp representing the time at which this Task was created. |
| date_modified | timestamp | A Unix timestamp representing the time at which this Task was last modified. |
- indicates a required field
URL: https://developer.copper.com/webhooks/overview.html
Webhooks¶
Webhooks allow systems integrated with Copper to receive near real-time notification of certain events so that data updates and workflows can be triggered.
Webhook concepts¶
| Concept | Description |
| Subscription | Register a URL that notifications will be sent to when a specific event type occurs. |
| Event | A specific action in Copper that triggers a notification. |
| Notification | The object delivered by an https request (webhook) to the specified URL. |
Event Types¶
The following events are available for subscription:
| Type | Description |
| Create | A new record is created. |
| Update | Any field in the existing entity record is changed. Excludes: new entity relationships, new Activity or any change in meta data. |
| Delete | An existing record is removed. |
Entity types¶
Events are available for the different entity types as follows.
| Record Type | Create | Update | Delete | Type |
| Lead | yes | yes | yes | “lead” |
| Person | yes | yes | yes | “person” |
| Company | yes | yes | yes | “company” |
| Opportunity | yes | yes | yes | “opportunity” |
| Project | yes | yes | yes | “project” |
| Task | yes | yes | yes | “task” |
| Activity | yes | yes | yes | “activity_log” |
Technical considerations¶
Subscription count¶
You may have up to 100 active subscriptions per account.
Rate limits¶
The number of notifications sent are bound by the following limits:
Multi-event notifications¶
Our notifications always send an array with the IDs of the records involved. The array contains at least 1 ID and may contain up
to 30 ID’s in a single notification. If more than 30 records are affected then we send multiple notifications, each with up to 30
IDs. Each notification counts as a single request towards the rate limit, regardless of the number of IDs it contains.
Retries¶
Our notifications are fired at most once per event, and we do not retry them, regardless of the status returned by the
notification endpoint.
HTTPS only¶
For security reasons only https:// endpoints are accepted for the notification URL.
Webhook properties¶
| Field | Type | Details |
| id | identifier | The unique ID of the subscription |
| target | string | The URL where the notification will be sent |
| type | string | The entity type on which the event occurs |
| event | string | The type of event that triggers the notificationnew,update,delete |
| secret | object | (Optional) Arbitrary data (e.g. for authentication) to pass to the webhook event, in the form { “key1”: “value1”, “key2”: “value2”, … } |
| headers | object | (Optional) HTTP headers to pass to the webhook, in the form { “key1”: “value1”, “key2”: “value2”, … } |
| custom_field_computed_values | boolean | If set to true, dropdown custom fields (standard and multi-select) will have their option_ids converted to the option names. |
| created_at | number | The date when the subscription was created |
URL: https://developer.copper.com/index.html
Copper Developer API¶
The Copper Web API allows you to access and build your own applications that interact with Copper in more complex ways than the integrations we provide out of the box.
The Copper Developer API (“Dev API”) provides a RESTful interface with JSON-formatted responses to access most Copper resources. We are continuously working on expanding our API functionality, so stay tuned!
Changelog ð¶
We have added a public changelog, please click here.
Domain Update â ︶
Please note that we’ve recently updated our domain to reflect an earlier application rebranding.
Our developer api can be found at https://api.copper.com/developer_api/, previously it was at https://api.prosperworks.com/developer_api/.
We are currently supporting auto-redirects for requests being made to the old domain and will continue to do so until early 2022.
Please update your Dev API requests with the new domain as soon as possible.
Change Policy¶
Our Developer API Change Policy is available here.
This policy defines how we will continue to support and maintain this Developer API going forward.
Postman Resources¶
To easily interact with the Copper Developer API, you may download our:
Import the Collection¶
To import the collection, open Postman and click Import, then select “Import From Link”
Copy & Paste the following link and press the “Import” button:
https://developer.copper.com/download/copper_postman_collection.json
Import and Use the Environment¶
To import the environment, open Postman and click Import, then select “Import From Link”
Copy & Paste the following link and press the “Import” button:
https://developer.copper.com/download/copper_postman_environment.json
After importing the environment, set it as your active environment in the top right-hand corner:
URL: https://developer.copper.com/introduction/change_policy.html
Change Policy¶
This policy applies to all incoming and outgoing APIs for Copper CRM that are accessible to partners, including:
From time to time Copper will change our APIs as we improve our products and services.
We divide changes into two types â backwards compatible and incompatible changes â and handle them separately.
Backwards-Compatible Changes¶
Most changes have a low probability of impacting partners, and we regard these changes as backwards-compatible:
What You Can Expect From Copper¶
We will occasionally make these changes to our APIs. When integrating with Copperâs APIs and SDKs, your code should be robust to these sorts of changes and should handle them without modification.
Change Process¶
When Copper makes backwards compatible changes to our APIs, we will modify the documentation to reflect the changes. For significant changes, we will announce changes according to our Communication Plan (see below).
Incompatible Changes¶
Any changes that are not listed above are considered backwards incompatible (âbreakingâ) changes, including:
What You Can Expect From Copper¶
Because these changes have a high chance of impacting partners, Copper will not make these changes without advance notice, as described below. You can assume that these changes will not be made unexpectedly.
Change Process¶
When Copper decides to make an incompatible change, we will mark the obsolete version as deprecated in our documentation and announce the deprecation to partners as described in the Communication Plan below.
We will continue to support deprecated APIs for at least six months from the announcement to allow partners to transition their integrations.
Communication Plan¶
When Copper makes significant changes to our API, we will notify our partners through the following channels:
In the case of breaking changes, that announcement will include a migration plan with advice for how to adjust your systems to avoid using the deprecated feature, and a timeline for when the deprecated feature will be removed.
Glossary¶
| Term | Definition |
| Field | A key-value pair in a JSON document, such as in a request or response body.Example: In{id: 1, name: “Clever User”}, theidandnameand their attached values are âfieldsâ. |
| Parameter | A value thatâs passed to the server in a URL, or in an SDK method.Examples:In/api/company_users?limit=10&offset=100,limitandoffsetare parameters.Insdk.getUser(1), the 1 is a parameter. |
URL: https://developer.copper.com/download/copper_postman_collection.json
URL: https://developer.copper.com/download/copper_postman_environment.json
URL: https://developer.copper.com/tags/overview.html
Tags¶
A Tag is a string that can be associated to any of the 6 core entities in Copper (Leads, People, Companies, Opportunities, Tasks, Projects).
Tag Properties
| Field | Type | Details |
| name | string | The name of the Tag. |
| count | integer | The total number of entities the Tag is associated to. |
| count_people | integer | The number of People the Tag is associated to. |
| count_leads | integer | The number of Leads the Tag is associated to. |
| count_companies | integer | The number of Companies the Tag is associated to. |
| count_opportunities | integer | The number of Opportunities the Tag is associated to. |
| count_projects | integer | The number of Projects the Tag is associated to. |
| count_tasks | integer | The number of Tasks the Tag is associated to. |
URL: https://developer.copper.com/activities/update-an-activity.html
Update an Activity¶
PUT https://api.copper.com/developer_api/v1/activities/{{update_activity_id}}
Request body¶
{
"activity_date": 1496772351,
"details": "This is the updated description of this note"
}Example Requests¶
Update a Note¶
curl --location --request PUT "https://api.copper.com/developer_api/v1/activities/{{update_activity_id}}" \
--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 "{
\"details\": \"This is the updated description of this note\",
\"activity_date\": 1496772351,
}"{
"id": 3064242278,
"parent": {
"id": 27140359,
"type": "person"
},
"type": {
"id": 0,
"category": "user"
},
"user_id": 137658,
"details": "This is the updated description of this note",
"activity_date": 1496772351,
"old_value": null,
"new_value": null,
"date_created": 1496772355,
"date_modified": 1496772355
}
Leave a Reply