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:

Possible search fields are: name, title, email, phone, date_modified, date_created, city, state, country, zip, socials.
See List Contact Types under Other Resources folder.
See List Opportunities (Search) in the Opportunities section of the docs.

Request Body¶

{
  "page_size": 25,
  "sort_by": "name"
}

Examples¶

People Search¶

Query200 response

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¶

Query200 response

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¶

Query200 Response

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¶

Query200 Response

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¶

Query200 Response

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¶

Query200 Response

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¶

Query200 Response

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¶

Query200 Response

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
  }
]

Query200 Response

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¶

Query200 Response

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¶

Query200 Response

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¶

Query200 Response

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¶

Query200 Response

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¶

Query200 Response

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¶

Query200 Response

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¶

Query200 Response

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¶

Query200 Response

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¶

Query200 Response

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¶

Query200 Response

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¶

Query200 Response

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
  }
]

Query200 Response

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
  }
]

List People (Search)¶

Request Body¶

Examples¶

People Search¶

Search by State¶

Search by Postal Code¶

Search by Followed¶

Search by Tags¶

Search by Socials¶

Search by Date Added¶

Search by Opportunity Ids¶

Search by Custom Multi-Select Dropdown¶

Search by City¶

Search by Interaction Count¶

Search by Assignee Id¶

Search by Full Name¶

Search by Phone Number¶

Search by Country¶

Search by Last Interaction Date¶

Search by Contact Type¶

Search by Company Id¶

List People in Groups of 200¶

Search by Custom Date Field¶

Search by Custom Multi-Select Dropdown Set to Empty¶