List Companies (Search)

POST https://api.copper.com/developer_api/v1/companies/search

The /search endpoint provides the ability to list Companies and sort the results by certain parameters. When multiple ciriteria are provided records meeting ALL criteria will be returned (the filtering criteria have an 'AND' relationship).

Certain fields can be filtered by an empty value, i.e., filter records where the field is not specified. For Companies, these fields are: city, state, postal_code, tags, custom dropdown, custom multi-select fields.

For an example of how this works, see Search Companies by Empty Field. Some fields (e.g. assignee_ids) can also filter for an empty value by specifying -2 as the ID.

To search by custom fields, see Search Entity by Custom Field under Custom Fields folder.

Note that this endpoint is eligible to return computed custom field values, click here for more information.

Field	Type	Details	Default
ids	identifier[]	An array of Company IDs.	none
page_number	number	The page number (starting with 1) that you would like to view.	1
page_size	number	The number of entries included in a page of results	20
sort_by	string	The field on which to sort the results (see footnote 1).	date_modified
sort_direction	string	The direction in which to sort the results. Possible values are: asc or desc.	asc
name	string	Full name of the Company to search for.	none
phone_number	string	Phone number of the Company to search for.	none
email_domains	string	Email domains of the Company to search for.	none
contact_type_ids	number[]	The contact type Ids to search for (see footnote 2).	none
assignee_ids	number[]	The ids of Users that Company must be owned by, or -2 for Company with no owner.	none
city	string	The city in which Company must be located.	none
state	string	The state or province in which Company must be located.	none
postal_code	string	The postal code in which Company must be located.	none
country	string	The two character country code where Company must be located.	none
tags	string[]	Filter Companies to those that match at least one of the tags specified.	none
socials	string[]	Filter Companies to those that match at least one of the social accounts specified.	none
followed	number	1: followed, 2: not followed	none
age	number	The maximum age in seconds that each Company must be.	none
minimum_interaction_count	number	The minimum number of interactions Company must have had.	none
maximum_interaction_count	number	The maximum number of interactions Company must have had.	none
minimum_interaction_date	timestamp	The Unix timestamp of the earliest date of the last interaction.	none
maximum_interaction_date	timestamp	The Unix timestamp of the latest date of the last interaction.	none
minimum_created_date	timestamp	The Unix timestamp of the earliest date Company are created.	none
maximum_created_date	timestamp	The Unix timestamp of the latest date Company are created.	none

Footnote:

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, socials.
2. See List Contact Types under Other Resources folder.
3. See List Opportunities (Search) under 5. Opportunities folder.

Request body

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

Example Requests

Companies Search

Query200 Response

curl --location --request POST "https://api.copper.com/developer_api/v1/companies/search" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json" \
  --data "{
  \"page_size\": 25,
  \"sort_by\": \"name\"
}"

[
  {
    "id": 13358412,
    "name": "Demo Company",
    "address": {
      "street": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94105",
      "country": null
    },
    "assignee_id": null,
    "contact_type_id": null,
    "details": "This is a demo company",
    "email_domain": "democompany.com",
    "phone_numbers": [
      {
        "number": "415-123-45678",
        "category": "work"
      }
    ],
    "primary_contact_id": 27140361,
    "socials": [],
    "tags": [],
    "websites": [
      {
        "url": "http://democompany.com",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 100764,
        "value": null
      },
      {
        "custom_field_definition_id": 103481,
        "value": null
      }
    ],
    "interaction_count": 0,
    "date_created": 1496707930,
    "date_modified": 1496707932
  },
  {
    "id": 9607580,
    "name": "Dunder Mifflin (sample)",
    "address": {
      "street": "213 West Main Street",
      "city": "Scranton",
      "state": "PA",
      "postal_code": "18501",
      "country": ""
    },
    "assignee_id": null,
    "contact_type_id": null,
    "details": "This is an update",
    "email_domain": "dundermifflin.com",
    "phone_numbers": [
      {
        "number": "4153554776",
        "category": "work"
      }
    ],
    "primary_contact_id": 27140362,
    "socials": [],
    "tags": [],
    "websites": [
      {
        "url": "http://www.dundermifflin.com/index.shtml",
        "category": "work"
      },
      {
        "url": "https://www.nbcstore.com/shop-by-show/the-office.html?shop_by_theme=7",
        "category": "work"
      },
      {
        "url": "http://dundermifflin.com",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 100764,
        "value": null
      },
      {
        "custom_field_definition_id": 103481,
        "value": null
      }
    ],
    "interaction_count": 0,
    "date_created": 1483988828,
    "date_modified": 1496708712
  },
  {
    "id": 13349319,
    "name": "Noemail",
    "address": null,
    "assignee_id": 137658,
    "contact_type_id": 451490,
    "details": null,
    "email_domain": "noemail.com",
    "phone_numbers": [],
    "primary_contact_id": 27140359,
    "socials": [],
    "tags": [],
    "websites": [],
    "custom_fields": [
      {
        "custom_field_definition_id": 100764,
        "value": "Text fields are 255 chars or less!"
      },
      {
        "custom_field_definition_id": 103481,
        "value": "Text area fields can have long text content"
      }
    ],
    "interaction_count": 0,
    "date_created": 1496694264,
    "date_modified": 1496694270
  },
  {
    "id": 9607579,
    "name": "ProsperWorks",
    "address": {
      "street": "221 Main Street Suite 1350",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94105",
      "country": ""
    },
    "assignee_id": null,
    "contact_type_id": 451493,
    "details": "Overview: ProsperWorks is the world's first zero input CRM. Designed specifically for Google Apps, ProsperWorks helps companies sell more faster by identifying, organizing and tracking sales opportunities right in Gmail, Calendar and Google Drive. By removing the need for data entry, salespeople can focus on developing business and managers can finally have accurate forecasting with real time activity tracking. ProsperWorks was founded by Jon Lee, Kelly Cheng and Andrew Hu with the commitment to empower small business sales and marketing. Jon was Founder/CEO of three big data companies that solved optimization problems in advertising, gaming and photo sharing. Each company realized successful exits. The team also includes the leaders in engineering and product from Facebook Mobile, BaseCRM and Salesforce. ProsperWorks has raised $10 million in funding from True Ventures, Bloomberg Beta, Crunchfund and other high-profile angel investors. ProsperWorks is based in San Francisco, CA.\n\nApprox. Number of Employees: 30\n\nFounded: 2011\n\nKeywords: Automotive, CRM, Finance, Google, Google Apps, Leadership, Management, Podcasting, SAAS, Sales, Small Business",
    "email_domain": "prosperworks.com",
    "phone_numbers": [
      {
        "number": "4153554776",
        "category": "work"
      }
    ],
    "primary_contact_id": 27140363,
    "socials": [
      {
        "url": "https://www.linkedin.com/company/prosperworks-inc-",
        "category": "linkedin"
      },
      {
        "url": "https://twitter.com/ProsperWorks",
        "category": "twitter"
      },
      {
        "url": "https://www.facebook.com/ProsperWorks",
        "category": "facebook"
      },
      {
        "url": "http://klout.com/ProsperWorks",
        "category": "klout"
      },
      {
        "url": "https://angel.co/prosperworks",
        "category": "other"
      },
      {
        "url": "https://plus.google.com/u/0/103594665195397142807",
        "category": "other"
      },
      {
        "url": "http://www.crunchbase.com/organization/prosperworks",
        "category": "other"
      }
    ],
    "tags": [],
    "websites": [
      {
        "url": "www.prosperworks.com",
        "category": "work"
      },
      {
        "url": "https://www.prosperworks.com",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 100764,
        "value": null
      },
      {
        "custom_field_definition_id": 103481,
        "value": null
      }
    ],
    "interaction_count": 0,
    "date_created": 1483988828,
    "date_modified": 1489018922
  },
  {
    "id": 9607581,
    "name": "Sabre Inc (sample)",
    "address": {
      "street": "543 Washington Ave",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "19135",
      "country": ""
    },
    "assignee_id": null,
    "contact_type_id": null,
    "details": null,
    "email_domain": null,
    "phone_numbers": [],
    "primary_contact_id": 27140364,
    "socials": [],
    "tags": [],
    "websites": [],
    "custom_fields": [
      {
        "custom_field_definition_id": 100764,
        "value": null
      },
      {
        "custom_field_definition_id": 103481,
        "value": null
      }
    ],
    "interaction_count": 0,
    "date_created": 1483988828,
    "date_modified": 1489018922
  }
]

Search Companies by Email Domains

Query200 Response

curl --location --request POST "https://api.copper.com/developer_api/v1/companies/search" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json" \
  --data "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"email_domains\": [\"dundermifflin.com\"]
}"

[
  {
    "id": 2,
    "name": "Dunder Mifflin (sample)",
    "address": {
      "street": "213 West Main Street",
      "city": "Scranton",
      "state": "PA",
      "postal_code": "18501",
      "country": null
    },
    "assignee_id": null,
    "contact_type_id": null,
    "details": null,
    "email_domain": "dundermifflin.com",
    "phone_numbers": [
      {
        "number": "4153554776",
        "category": "work"
      }
    ],
    "primary_contact_id": 27140359,
    "socials": [],
    "tags": [],
    "websites": [
      {
        "url": "http://www.dundermifflin.com/index.shtml",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "interaction_count": 0,
    "date_created": 1519852352,
    "date_modified": 1519852398
  }
]

Search Companies by Contact Type Ids

Query200 Response

curl --location --request POST "https://api.copper.com/developer_api/v1/companies/search" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json" \
  --data "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"contact_type_ids\": [6]
}"

[
  {
    "id": 4,
    "name": "Sabre Inc (sample)",
    "address": {
      "street": "543 Washington Ave",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "19135",
      "country": ""
    },
    "assignee_id": 2,
    "contact_type_id": 6,
    "details": null,
    "email_domain": null,
    "phone_numbers": [],
    "primary_contact_id": 27140359,
    "socials": [],
    "tags": [],
    "websites": [],
    "custom_fields": [
      {
        "custom_field_definition_id": 8,
        "value": null
      },
      {
        "custom_field_definition_id": 11,
        "value": null
      }
    ],
    "interaction_count": 0,
    "date_created": 1515434867,
    "date_modified": 1516320789
  }
]

Search Companies by Custom Date Field

Query200 Response

curl --location --request POST "https://api.copper.com/developer_api/v1/companies/search" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json" \
  --data "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"custom_fields\": [{
    \"custom_field_definition_id\": 6,
    \"minimum_value\": 1515744000,
    \"maximum_value\": 1515745000
  }]
}"

[
  {
    "id": 4,
    "name": "Sabre Inc (sample)",
    "address": {
      "street": "543 Washington Ave",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "19135",
      "country": "US"
    },
    "assignee_id": 2,
    "contact_type_id": 6,
    "details": null,
    "email_domain": null,
    "phone_numbers": [],
    "primary_contact_id": 27140365,
    "socials": [],
    "tags": [
      "tag1"
    ],
    "websites": [],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      }
    ],
    "interaction_count": 0,
    "date_created": 1515434867,
    "date_modified": 1516324052
  }
]

Search Companies by Postal Code

Query200 Response

curl --location --request POST "https://api.copper.com/developer_api/v1/companies/search" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json" \
  --data "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"postal_code\": \"18501\"
}"

[
  {
    "id": 3,
    "name": "Dunder Mifflin (sample)",
    "address": {
      "street": "213 West Main Street",
      "city": "Scranton",
      "state": "PA",
      "postal_code": "18501",
      "country": "US"
    },
    "assignee_id": null,
    "contact_type_id": 5,
    "details": null,
    "email_domain": "dundermifflin.com",
    "phone_numbers": [
      {
        "number": "4153554776",
        "category": "work"
      }
    ],
    "primary_contact_id": 27140356,
    "socials": [],
    "tags": [],
    "websites": [
      {
        "url": "http://www.dundermifflin.com/index.shtml",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 8,
        "value": null
      },
      {
        "custom_field_definition_id": 11,
        "value": null
      }
    ],
    "interaction_count": 0,
    "date_created": 1515434866,
    "date_modified": 1516323758
  }
]

Search Companies by Last Interaction

Query200 Response

curl --location --request POST "https://api.copper.com/developer_api/v1/companies/search" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json" \
  --data "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"minimum_interaction_date\": 1516262400,
  \"maximum_interaction_date\": 1516313000
}"

[
  {
    "id": 2,
    "name": "ProsperWorks",
    "address": {
      "street": "221 Main Street Suite 1350",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94105",
      "country": ""
    },
    "assignee_id": null,
    "contact_type_id": 8,
    "details": null,
    "email_domain": "prosperworks.com",
    "phone_numbers": [
      {
        "number": "4153554776",
        "category": "work"
      }
    ],
    "primary_contact_id": 27140367,
    "socials": [
      {
        "url": "https://www.linkedin.com/company/prosperworks-inc-",
        "category": "linkedin"
      }
    ],
    "tags": [],
    "websites": [
      {
        "url": "www.prosperworks.com",
        "category": "work"
      },
      {
        "url": "https://www.prosperworks.com",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 12,
        "value": [
          9
        ]
      },
      {
        "custom_field_definition_id": 8,
        "value": null
      }
    ],
    "interaction_count": 2,
    "date_created": 1515434866,
    "date_modified": 1516324063
  },
  {
    "id": 4,
    "name": "Sabre Inc (sample)",
    "address": {
      "street": "543 Washington Ave",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "19135",
      "country": "US"
    },
    "assignee_id": 2,
    "contact_type_id": 6,
    "details": null,
    "email_domain": null,
    "phone_numbers": [],
    "primary_contact_id": 27140368,
    "socials": [],
    "tags": [
      "tag1"
    ],
    "websites": [],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      }
    ],
    "interaction_count": 2,
    "date_created": 1515434867,
    "date_modified": 1516324258
  }
]

Search Companies by City

Query200 Response

curl --location --request POST "https://api.copper.com/developer_api/v1/companies/search" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json" \
  --data "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"city\": \"Philadelphia\"
}"

[
  {
    "id": 4,
    "name": "Sabre Inc (sample)",
    "address": {
      "street": "543 Washington Ave",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "19135",
      "country": ""
    },
    "assignee_id": 2,
    "contact_type_id": 6,
    "details": null,
    "email_domain": null,
    "phone_numbers": [],
    "primary_contact_id": 27140369,
    "socials": [],
    "tags": [],
    "websites": [],
    "custom_fields": [
      {
        "custom_field_definition_id": 8,
        "value": null
      },
      {
        "custom_field_definition_id": 11,
        "value": null
      }
    ],
    "interaction_count": 0,
    "date_created": 1515434867,
    "date_modified": 1516320789
  }
]

Search Companies by Socials

Query200 Response

curl --location --request POST "https://api.copper.com/developer_api/v1/companies/search" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json" \
  --data "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"socials\": [\"https://www.linkedin.com/in/sabreinc\"]
}"

[
  {
    "id": 4,
    "name": "Sabre Inc (sample)",
    "address": {
      "street": "543 Washington Ave",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "19135",
      "country": ""
    },
    "assignee_id": 2,
    "contact_type_id": 6,
    "details": null,
    "email_domain": null,
    "phone_numbers": [],
    "primary_contact_id": 27140370,
    "socials": [
      {
        "url": "https://www.linkedin.com/in/sabreinc",
        "category": "linkedin"
      }
    ],
    "tags": [],
    "websites": [],
    "custom_fields": [
      {
        "custom_field_definition_id": 8,
        "value": null
      },
      {
        "custom_field_definition_id": 11,
        "value": null
      }
    ],
    "interaction_count": 0,
    "date_created": 1515434867,
    "date_modified": 1516320789
  }
]