Activity Type

User

Activities

Assignee

Not followed

Followed

Companies

Contact Types

Customer Sources

Lead Statuses

Customer Source

Email Details

Email

Leads

Company

Loss Reason

Pipeline

Pipeline Stage

Primary Contact

Priority

Status

Opportunities

Opportunity Loss Reasons

Opportunity Pipeline Stages

Opportunity Pipelines

Contact Type

Emails

People

System Activity Types

Tasks

User Activity Types

Users

Copper

Fetch Account Details

Fetch User by ID

**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      |

List Users

Fetch a Lead by 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'.

Update a Lead

This request permanently removes a Lead from your Copper account.

Delete a Lead

Create a New Lead

**Functionality**

"Upsert" (update + insert) will atomically do the following:
1. Check for the existence of a Lead matching certain criteria
1. If one exists, update it with the supplied parameters.
1. If not, create a new Lead with the supplied parameters.
1. This is particularly useful to avoid creating duplicate Leads.

**Match Criteria**

The supported match criteria are:
* Name
* Email
* Custom Fields

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:

* If no matches are found, create a new Lead.
* If exactly one match is found, update that Lead.
* If more than one match is found, return a 422 response with the IDs of the matching Leads.
* If more than 30 matches are found, return a 422 response without the IDs of the matching Leads.

UPSERT a Lead

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.

| 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. |

CONVERT a Lead

The /search endpoint provides the ability to list Leads 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 `Leads 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 Leads, these fields are: city, state, postal_code, tags, custom dropdown, custom multi-select fields. For an example of how this works, see `Search Leads 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.

To change the number of records returned, change the "page_size" parameter. E.g., specify 200 for a page size of 200 records.



|           Field           |    Type   |                                    Details                                    | Default |
| ------------------------- | --------- | ----------------------------------------------------------------------------- | ------- |
| page_number               | number    | The page number (starting with 1) that you would like to view.                | 1       |
| page_size                 | number    | The number of entries included in a page of results                           | 20      |
| sort_by                   | string    | The field on which to sort the results (see footnote 1).                      | 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    |
| 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    |

Foonotes:
1. Possible fields are: name, first_name, last_name, company_name, title, value, email, phone, date_modified, date_created, city, state, country, zip, inactive_days.
   - date_modified and date_created: sorting is from oldest to newest
   - inactive_days: sorting is from newest to oldest
2. To get User IDs, see `List Users` under `Acount and Users` folder. Enter -2 as an ID for no assignee.
3. To get lead status IDs, see `List Lead Statuses` under `Other Resources` folder.
4. To get customer source IDs, see `List Customer Sources` under `Other Resources` folder. Enter -2 as an ID for no customer source.

List Leads (Search)

This request will show the Activity entries created for a specific Lead. For more details please see the notes at the [/activities endpoint](https://dev.prosperworks.com).

See a Lead's Activities

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|Details|
|---|---|
|id (number)|Unique* identifier for the customer source.|
|name (string)|  Label for the customer source definition|

List Customer Sources

Lead statuses are values that can be assigned to a Lead entity to indicate where they are in the qualification process.

|        Field         |                                  Description                                   |
| -------------------- | ------------------------------------------------------------------------------ |
| id (number)          | 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 |

List Lead Statuses

Fetch a Person by 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.

Update a Person

This request permanently removes a Person from your Copper account.

Delete a Person

Email address is a unique key for People records in Copper. You can fetch a Person by it's email address using this operation.

Fetch a Person by Email

Create a New Person

The /search endpoint provides the ability to list people 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 `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 Leads, 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.

|           Field           |    Type   |                                    Details                                     | Default    |
| ------------------------- | --------- | ------------------------------------------------------------------------------ | ---------- |
| page_number               | number    | The page number (starting with 1) that you would like to view.                 | 1          |
| page_size                 | number    | The number of entries included in a page of results                            | 20         |
| sort_by                   | string    | The field on which to sort the results (see footnote 1).                       | first_name |
| sort_direction            | string    | The direction in which to sort the results. Possible values are: asc or desc.  | asc        |
| name                      | string    | Full name of the People to search for.                                         | none       |
| phone_number              | string    | Phone number of the People to search for.                                      | none       |
| emails                    | string[]  | Emails of the People to search for.                                            | none       |
| contact_type_ids          | number[]  | The contact type Ids to search for (see footnote 2).                           | none       |
| assignee_ids              | number[]  | The ids of Users that People must be owned by, or -2 for People with no owner. | none       |
| company_ids               | number[]  | The ids of Companies that People belong to, or -2 for People with no company.  | none       |
| opportunity_ids           | number[]  | 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 Leads to those that match at least one of the tags 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       |

Footnote:
1. Possible fields are: name, first_name, last_name, title, email, phone, date_modified, date_created, city, state, country, zip.
2. See `List Contact Types` under Other Resources folder.
3. See `List Opportunities (Search)` under 5. Opportunities folder.

List People (Search)

This request will show the Activity entries created for a specific Person. For more details, please see the notes in the [Activities](https://developer.copper.com/?version=latest#2c9a03e2-bb9f-431b-8d22-3ff741d8dee3) section.

See a Person's Activities

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|number|Unique identifier for the Contact Type.|
|name|string|The name of the Contact Type.|

List Contact Types

Fetch a Company by ID

Update a Company

Create a New Company 

This request permanently removes a Company from your Copper account.

Delete a Company

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).

To see examples of search request using the various parameters, click on the `Companies 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 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.

To change the number of records returned, change the "page_size" parameter. E.g., specify 200 for a page size of 200 records.

|           Field           |    Type   |                                    Details                                       | Default       |
| ------------------------- | --------- | -------------------------------------------------------------------------------- | ------------- |
| page_number               | number    | The page number (starting with 1) that you would like to view.                   | 1             |
| page_size                 | number    | The number of entries included in a page of results                              | 20            |
| sort_by                   | string    | The field on which to sort the results (see footnote 1).                         | 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 Leads to those that match at least one of the tags 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:
1. Possible fields are: name, phone, contact, contact_first_name, contact_last_name, date_modified, date_created, email_domain, city, state, country, zip, assignee, contact_group, last_interaction, interaction_count, primary_website.
2. See `List Contact Types` under Other Resources folder.
3. See `List Opportunities (Search)` under 5. Opportunities folder.

List Companies (Search)

This request will show the Activity entries created for a specific Company. For more details please see the notes at the [/activities endpoint](https://dev.prosperworks.com).

See a Company's Activities

Fetch an Opportunity by ID

Update an Opportunity

The following fields are required for this request:

"name"

"primary_contact_id"

Create a New Opportunity

This request permanently removes a record from your Copper account.

Delete an Opportunity

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).

To see examples of search request using the various parameters, click on the `Opportunities 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 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.

To change the number of records returned, change the "page_size" parameter. E.g., specify 200 for a page size of 200 records.

|           Field           |    Type   |                                    Details                                                   | Default |
| ------------------------- | --------- | -------------------------------------------------------------------------------------------- | ------- |
| page_number               | number    | The page number (starting with 1) that you would like to view.                               | 1       |
| page_size                 | number    | The number of entries included in a page of results                                          | 20      |
| sort_by                   | string    | The field on which to sort the results (see footnote 1).                                     | 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              | number[]  | The ids of Users that Opportunities must be owned by, or -2 for Opportunities with no owner. | none    |
| status_ids                | number[]  | An array of Opportunity status IDs as integers. The integer values are 0, 1, 2, 3, for "Open", "Won", "Lost", and "Abandoned", respectively. | none    |
| pipeline_ids              | number[]  | An array of pipeline IDs.                                                                    | none    |
| pipeline_stage_ids        | number[]  | An array of pipeline stage IDs.                                                              | none    |
| priority_ids              | number[]  | An array of priority IDs.                                                                    | none    |
| customer_source_ids       | number[]  | An array of customer source IDs, or -2 for no customer source.                               | none    |
| loss_reason_ids           | number[]  | An array of loss reason IDs, or -2 for no loss reason.                                       | none    |
| company_ids               | number[]  | 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    |

Foonotes:
1. Possible fields are: name, account, company_name, value, assignee, customer_source_id, date_modified, date_created, contact, stage, status, close_date, source, priority, last_interaction, interaction_count, deal_last_stage, win_probability.

List Opportunities (Search)

Loss Reasons identify why a particular Opportunity was lost. The Loss Reasons API allows you to retrieve the list of Loss Reasons associated with your Copper account.


|     Field     |              Description               |
| ------------- | -------------------------------------- |
| id (number)   | Unique identifier for the Loss Reason. |
| name  (string) | The name of the Loss Reason.          |

List Loss Reasons

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     |                    Details                    |
| ------------- | --------------------------------------------- |
| id  (number)   | Unique identifier for the Pipeline.           |
| name  (string) | The name of the Pipeline.                     |
| stages  (list) | The list of Pipeline Stages in this Pipelines |

List Pipelines

Pipeline Stages define the positions of Opportunities within their Pipelines. The Pipeline Stages API allows you to retrieve the list of Pipeline Stages associated with your Copper account.


|          Field           |                                                     Details                                                      |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------- |
| id (number)              | Unique identifier for the Pipeline Stage.                                                                        |
| name (string)            | The name of the Pipeline Stage.                                                                                  |
| pipeline_id (number)     | The unique identifier of the Pipeline in which this Pipeline Stage is.                                           |
| win_probability (number) | The expected probability of winning an Opportunity in this Pipeline Stage. Valid values are [0-100] (inclusive). |

List Pipeline Stages

List Stages in a Pipeline

Fetch a Project by ID

Update a Project

The following fields are required for this request:

"name"

Create a New Project

Delete a Project

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.

To change the number of records returned, change the "page_size" parameter. E.g., specify 200 for a page size of 200 records.


|           Field           |    Type   |                                    Details                                                   | Default |
| ------------------------- | --------- | -------------------------------------------------------------------------------------------- | ------- |
| page_number               | number    | The page number (starting with 1) that you would like to view.                               | 1       |
| page_size                 | number    | The number of entries included in a page of results                                          | 20      |
| sort_by                   | string    | The field on which to sort the results (see footnote 1).                                     | 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              | number[]  | The ids of Users that Opportunities must be owned by, or -2 for Opportunities with no owner. | none    |
| status_ids                | number[]  | 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    |

Foonotes:
1. Possible fields are: name, assigned_to, related_to, status, date_modified, date_created.

List Projects (Search)

Fetch a Task by ID

Update a Task

Create a New Task

Delete a Task

The /search endpoint provides the ability to list people 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 `Tasks 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 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` under `Custom Fields` folder.

To change the number of records returned, change the "page_size" parameter. E.g., specify 200 for a page size of 200 records.

|           Field           |    Type   |                                    Details                                     | Default    |
| ------------------------- | --------- | ------------------------------------------------------------------------------ | ---------- |
| page_number               | number    | The page number (starting with 1) that you would like to view.                 | 1          |
| page_size                 | number    | The number of entries included in a page of results                            | 20         |
| sort_by                   | string    | The field on which to sort the results (see footnote 1).                       | due_date   |
| sort_direction            | string    | The direction in which to sort the results. Possible values are: asc or desc.  | asc        |
| assignee_ids              | number[]  | The ids of Users that Tasks must be owned by, or -2 for Tasks with no owner.   | none       |
| opportunity_ids           | number[]  | An array of Opportunity IDs (see footnote 2).                                  | none       |
| project_ids               | number[]  | 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:
1. Possible fields are: name, assigned_to, related_to, status, priority, due_date, reminder_date, completed_date, date_created, date_modified.
2. See `List Opportunities (Search)` under 5. Opportunities folder.

List Tasks (Search)

Fetch an Activity by ID

Create a New Activity

Delete an Activity

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 `Search Activities` dropdown on the right.

|     Field             |      Type       |                               Details                                                                            | Default |
| --------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------- | ------- |
| parent                | hash            | A hash describing the resource to which activities must belong (footnote 1).                                     |         |
| activity_types        | activity_type[] | The activity types to filter results on (footnote 1).                                                            | 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      |
| minimum_activity_date | number          | The Unix timestamp of the earliest activity date.                                                                | none    |
| maximum_activity_date | number          | The Unix timestamp of the latest activity date.                                                                  | none    |
| full_result           | boolean         | (Optional) If set to true, search performance improves but duplicate activity logs may be returned (footnote 3). | false   |

Footnotes:
1. Parent is specified by: {"id": parent_id, "type": parent_type}. "parent_type" can be "lead", "person", "company", "opportunity", "project", "task". 
2. Activity types is specified by: {"id": activity_type_id, "category": category }. "activity_type_id" and "category" can be retrieved from `List Activity Types` under `Other Resources` folder.
3. If the List Activities Search endpoint is timing out, a flag `full_result=true` can be added. One can expect to see multiple entries returned for the same activity if an email was sent to multiple users. In order to use this flag, user must have admin capabilities. Otherwise, the flag is ignored.

List Activities (Search)

Activity Types identify the types of Activities that occur in Copper. The Activity Types Developer API allows you to retrieve the list of Activity Types associated with your Copper account. There are two categories of Activity Type.


Activity Types with category "user" describe user-entered Activities. By default, Copper has three user-entered activity types: Notes, Phone Calls, and Meetings. Notes have a hard-coded ID of 0. Phone Calls and Meetings are assigned IDs when your Copper account is created. Users may also create Custom Activity Types through the Settings page. These will be assigned IDs when they are created.


Custom Activity Types that have been removed from the list in the Settings page are not deleted from Copper, because they are necessary to correctly handle Activities of those types. These Activity Types are visible through the Developer API for Activity Types, and can be used for filtering Activity searches, but cannot be used to create new Activities.


Activity Types with category "system" describe system-generated Activities. There are currently two system activities: "Property Changed" and "Pipeline Stage Changed". They have hard-coded IDs of 1 and 3 respectively.

|        Field         |  Type   |                                                       Details                                                       |
| -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------- |
| id                   | number  | The id of the Activity Type.                                                                                        |
| category             | string  | The category of the Activity Type. Valid categories: user, system.                                                  |
| name                 | string  | The name of the Activity Type.                                                                                      |
| is_disabled          | boolean | For Custom Activity Types, whether or not the Activity Type is disabled.                                            |
| count_as_interaction | boolean | For Activity Types of category "user", whether or not Activities of this type are counted toward interactions data. |

When supplied as parameters for Activity creation or search, Activity Type objects need only specify the "category" and "id" fields. Any other values provided will be ignored.

List Activity Types

Custom Field Definitions specify account specific fields not included as part of the standard resource fields and allows Copper to be customized to your specific workflow. The Custom Field Definitions API allows you to retrieve the list of Custom Field Definitions associated with your Copper account.

|   Field   |     Type      |                                                                            Details                                                                             |
| --------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id        | number        | Unique identifier for the custom field definition.                                                                                                            |
| name      | string        | Label for the custom field definition                                                                                                                          |
| data_type | string enum   | The type of data that should be stored within this custom field. Possible values are: String, Text, Dropdown, Date, Checkbox, Float, URL, Percentage, Currency, Connect |
| currency  | string enum   | The currency used for this custom field definition. Valid only when the data type is Currency.                                                                 |
| options   | options array | A list of possible dropdown options. Valid only when the data type is Dropdown.                                                                                |

List Custom Field Definitions

| Field                 | Type          | Details | Default |
| --------------------- | ------------- | ----------------------- | ---------------------- |
| name*              | string | Name of the Custom Field Definition                     |                      |
| data_type*                  | string | One of the following strings: "Checkbox", "Currency", “Date", "Dropdown", "Float", "MultiSelect", "Percentage", “String", "Text", "URL" |                      |
| available_on              | string array       | List of strings containing one or more of the following: “lead”, “person”, “opportunity”, “company”, "project", "task"                      |                      |
| options          | integer array       | Array of options for Dropdown and MultiSelect fields.  A minimum of one option is required for Dropdown and a minimum of 2 options is required for MultiSelect                      |                      |
| currency            | string | 3-letter country code (e.g., "USD", "CAD")                     |                      |
|\* indicates a required field| | |

Create a new custom field definition

Fetch a Custom Field Definition

Update an existing custom field definition

Delete a Custom Field Definition

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              | integer array | Yes                     | No                     |
| Date                  | integer range | No                      | No                     |
| Checkbox              | boolean       | No                      | No                     |
| Number Field          | numeric       | No                      | No                     |
| Percentage            | numeric range | No                      | No                     |
| Currency              | integer range | No                      | No                     |
| Multi-Select Dropdown | integer 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.

Search Entity (Leads, People, etc) by Custom Field

List All Custom Activity Types

|   Field                     | Type   |  Details  |  Default  |
| --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | - |
| name*                       | string | Name of the custom activity type.                                                                                                              |   |
| icon_type*                  | string | Icon Type. Must be one of: "Message", "Phone", "Event", "Assignment", "Assessment", "Group", "Description", "Speaker Notes", "Forum", "Web", "Loyalty", "Content Paste", "Headset", "Share", "Navigation", "Notification", "Voicemail", "Room", "Edit", "Send", "Videocam", "Play Arrow", "Grocery Store", "Mic", "Camera Mic", "Todo" | |

*indicates a required field

Create a New Custom Activity Type

Get Custom Activity Type

|   Field                     | Type   |  Details  |  Default  |
| --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | - |
| name                        | string | Name of the custom activity type.                                                                                                              |   |
| icon_type                   | string | Icon Type. Must be one of: "Message", "Phone", "Event", "Assignment", "Assessment", "Group", "Description", "Speaker Notes", "Forum", "Web", "Loyalty", "Content Paste", "Headset", "Share", "Navigation", "Notification", "Voicemail", "Room", "Edit", "Send", "Videocam", "Play Arrow", "Grocery Store", "Mic", "Camera Mic", "Todo" | |

Update an Existing Custom Activity Type

To retrieve already existing connections in the connect field, use the list the connections API.

List the connections on specified entity

Once you have created connect fields, use the create a connection API to add connections to the connect field.

Create a connection

To delete already existing connections in the connect field, use the delete a connection API.

Delete a connection

View all records related to an Entity

View all records of a given Entity Type related to an Entity

Please note that when relating records this way, both records have to exist in the system already.

Relate an existing record to an Entity

Removing the relationship does not cause any of the records involved to be deleted from the system.

Remove relationship between record and Entity

This API endpoint lists all the attached files for a given entity type and id,
where {{entity_type}} and {{entity_id}} are replaced with the following:

|           Field           |    Type     |                                    Details                                    | Default |
| ------------------------- | ----------- | ----------------------------------------------------------------------------- | ------- |
| entity_type*              | string      | Must be one of: "leads", "people", "opportunities", "companies", "projects"   |         |
| entity_id*                | number      | ID of the entity record                                                       |         |
| \* indicates a required field ||||

List attached files of an entity record

This API endpoint is step 3 of 3 to upload a file and attach it to an existing entity.

The endpoint relates the uploaded file to a specific entity,
where {{entity_type}} and {{entity_id}} are replaced with the following:

|           Field           |    Type     |                                    Details                                    | Default |
| ------------------------- | ----------- | ----------------------------------------------------------------------------- | ------- |
| entity_type*              | string      | Must be one of: "leads", "people", "opportunities", "companies", "projects"   |         |
| entity_id*                | number      | ID of the entity record                                                       |         |
| \* indicates a required field ||||

Upload 3: Relate the uploaded file to a specific entity

This API endpoint gets the detailed metadata for a file for a given entity type and id and the file id. File id can be found using the "List attached files of an entity record",
where {{entity_type}}, {{entity_id}}, and {{file_id}} are replaced with the following:

|           Field           |    Type     |                                    Details                                    | Default |
| ------------------------- | ----------- | ----------------------------------------------------------------------------- | ------- |
| entity_type*              | string      | Must be one of: "leads", "people", "opportunities", "companies", "projects"   |         |
| entity_id*                | number      | ID of the entity record                                                       |         |
| file_id*                  | number      | ID of the attached file                                                       |         |
| \* indicates a required field ||||

Get metadata of a specific attached file

This API endpoint is step 1 of 3 to upload a file and attach it to an existing entity.

The endpoint gets a signed S3 URL to start the upload process,
where {{entity_type}} and {{entity_id}} are replaced with the following:

|           Field           |    Type     |                                    Details                                    | Default |
| ------------------------- | ----------- | ----------------------------------------------------------------------------- | ------- |
| entity_type*              | string      | Must be one of: "leads", "people", "opportunities", "companies", "projects"   |         |
| entity_id*                | number      | ID of the entity record                                                       |         |
| \* indicates a required field ||||

Upload 1: Get signed S3 URL

This API endpoint is step 2 of 3 to upload a file and attach it to an existing entity.

The endpoint uploads the file to Amazon S3 service,
in which the following parameters are required:

|           Field           |    Type     |                                    Details                                    | Default |
| ------------------------- | ----------- | ----------------------------------------------------------------------------- | ------- |
| key*                      | string      | Value of "key" from response of Upload 1 API endpoint                         |         |
| signature*                | string      | Value of "signature" from response of Upload 1 API endpoint                   |         |
| success_action_status*    | string      | Value of "success_action_status" from response of Upload 1 API endpoint       | 201     |
| acl*                      | string      | Value of "acl" from response of Upload 1 API endpoint                         | private |
| AWSAccessKeyId*           | string      | Value of "aws_access_key_id" from response of Upload 1 API endpoint           |         |
| policy*                   | string      | Value of "policy" from response of Upload 1 API endpoint                      |         |
| file*                     | string      | String representing the full path to file on user's local computer            |         |
| \* indicates a required field ||||

Upload 2: Upload your file to S3

This is the description of the individual request

List all subscriptions

"event" = "new" | "update" | "delete"

"type" = "lead" | "person" | "company" | "opportunity" | "project" | "task"

Also, you may specify an optional hash object called "secret" containing custom key/value pairs that is sent with every notification. Using this secret your notification endpoint can authenticate the request to make sure it is coming from a trusted source.

This example shows the creation of a new notification for events when existing Leads are updated.

Create new subscription

Delete subscription (unsubscribe)

View subscription by ID

HubSpot

Salesforce

MS Dynamics CRM

Zoho CRM

Pipedrive

Freshsales

Outreach

ActiveCampaign

Xero

Capsule CRM

Salesloft

Agile CRM

SalesForce Pardot

Teamleader

Zendesk

Sage Accounting

Attio

Zoho Books

Front

Close

Freshdesk

# Delete Company

This scenario allows your application to delete a Company from any external application. 
You will pass ID of the Company you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Company API call**:
   - Call Integration.app REST API or SDK with ID of the Company you want to delete and Integration.app will send the correct request to the external app.


Delete Company

Deletes Company in any external application

Google Calendar

# Get all Activities

This scenario enables your application to get a complete list of Activities from any external application to your app's API in the same way. 

When receiving Activities data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Activities along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Activities page by page.


Get all Activities

Imports all Activities from any external application to your App.

# Realtime Full two-way Sync of Companies

This scenario enables your application to fully sync Companies between your app and any external application in both directions. It handles the initial import/export of Companies and then sends events when a Company is created, updated, or deleted on any side, as close to real-time as possible.

Company fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Companies in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Companies to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Companies

Bi-directional realtime sync of Companies with records deduplication

# Update Activity

This scenario allows your application to update a Activity in any external application in the same way. 
You will pass  ID of the Activity you want to update and Activity fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.

## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to update Activity with and configure mapping to our default model

2. **Create Activity API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured and ID. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Activity data into a format compatible with the selected external application.
   - It then makes an API call to update the Activity in that specific application.


Update Activity

Updates Activity in any external application

Keap

SugarCRM

SharpSpring

Breezy HR

Exact Online

# Get all Companies

This scenario enables your application to get a complete list of Companies from any external application to your app's API in the same way. 

When receiving Companies data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Companies along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Companies page by page.


Get all Companies

Imports all Companies from any external application to your App.

Mailchimp

AWeber

# Get all Contacts

This scenario enables your application to get a complete list of Contacts from any external application to your app's API in the same way. 

When receiving Contacts data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Contacts along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Contacts page by page.


Get all Contacts

Imports all Contacts from any external application to your App.

Copper API Integration Profile

Supercharge your product integrations today