Copper API Integration Profile

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.