Skip to content

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

1
2
3
4
{
  "page_size": 25,
  "sort_by": "name"
}

Example Requests

1
2
3
4
5
6
7
8
9
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\"
}"

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
[
  {
    "id": 13358412,
    "name": "Demo Company",
    "address": {
      "street": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94105",
      "country": null
    },
    "assignee_id": null,
    "contact_type_id": null,
    "details": "This is a demo company",
    "email_domain": "democompany.com",
    "phone_numbers": [
      {
        "number": "415-123-45678",
        "category": "work"
      }
    ],
    "socials": [],
    "tags": [],
    "websites": [
      {
        "url": "http://democompany.com",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 100764,
        "value": null
      },
      {
        "custom_field_definition_id": 103481,
        "value": null
      }
    ],
    "interaction_count": 0,
    "date_created": 1496707930,
    "date_modified": 1496707932
  },
  {
    "id": 9607580,
    "name": "Dunder Mifflin (sample)",
    "address": {
      "street": "213 West Main Street",
      "city": "Scranton",
      "state": "PA",
      "postal_code": "18501",
      "country": ""
    },
    "assignee_id": null,
    "contact_type_id": null,
    "details": "This is an update",
    "email_domain": "dundermifflin.com",
    "phone_numbers": [
      {
        "number": "4153554776",
        "category": "work"
      }
    ],
    "socials": [],
    "tags": [],
    "websites": [
      {
        "url": "http://www.dundermifflin.com/index.shtml",
        "category": "work"
      },
      {
        "url": "https://www.nbcstore.com/shop-by-show/the-office.html?shop_by_theme=7",
        "category": "work"
      },
      {
        "url": "http://dundermifflin.com",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 100764,
        "value": null
      },
      {
        "custom_field_definition_id": 103481,
        "value": null
      }
    ],
    "interaction_count": 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": [],
    "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"
      }
    ],
    "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": [],
    "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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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\"]
}"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
[
  {
    "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"
      }
    ],
    "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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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]
}"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
[
  {
    "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": [],
    "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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
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
  }]
}"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
[
  {
    "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": [],
    "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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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\"
}"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
[
  {
    "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"
      }
    ],
    "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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
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
}"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
[
  {
    "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"
      }
    ],
    "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": [],
    "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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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\"
}"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
[
  {
    "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": [],
    "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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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\"]
}"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
[
  {
    "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": [],
    "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
  }
]