List Contacts by Search

GET

https://app.brightmove.com/ATS/app/contact/search/

GET

/ATS/app/contact/search/

1 curl -G https://app.brightmove.com/ATS/app/contact/search/ \
2      -H "Content-Type: application/json" \
3      --data-urlencode "name=Acme Corporation"

200Retrieved

1 [
2   {
3     "userGk": 10234,
4     "guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
5     "salutation": {
6       "id": 1,
7       "name": "Mr."
8     },
9     "firstName": "John",
10     "middleName": "A.",
11     "lastName": "Doe",
12     "nickname": "Johnny",
13     "email": "john.doe@acmecorp.com",
14     "workEmail": "j.doe@acmecorp.com",
15     "type": {
16       "id": 3,
17       "name": "Contact"
18     },
19     "companyGk": 5678,
20     "companyName": "Acme Corporation",
21     "companyGuid": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
22     "createUserGk": 1001,
23     "modifyUserGk": 1002,
24     "username": "jdoe",
25     "avatarUrl": "https://acmecorp.com/avatars/jdoe.png",
26     "timezoneId": 5,
27     "localeId": 1033,
28     "statusId": 1,
29     "phones": [
30       {
31         "id": 201,
32         "phoneNumber": "+1-555-123-4567",
33         "type": {
34           "id": 1,
35           "name": "Work",
36           "sortOrder": 1,
37           "choice": true
38         },
39         "userGk": 10234
40       }
41     ],
42     "primary": true,
43     "createUser": {
44       "userGk": 1001,
45       "guid": "11111111-2222-3333-4444-555555555555",
46       "salutation": {
47         "id": 2,
48         "name": "Ms."
49       },
50       "firstName": "Alice",
51       "middleName": "B.",
52       "lastName": "Smith",
53       "nickname": "Ally",
54       "email": "alice.smith@acmecorp.com",
55       "workEmail": "a.smith@acmecorp.com",
56       "type": {
57         "id": 1,
58         "name": "Employee"
59       },
60       "companyGk": 5678,
61       "companyName": "Acme Corporation",
62       "companyGuid": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
63       "createUserGk": 1000,
64       "modifyUserGk": 1000,
65       "username": "asmith",
66       "avatarUrl": "https://acmecorp.com/avatars/asmith.png",
67       "timezoneId": 5,
68       "localeId": 1033,
69       "statusId": 1,
70       "displayFullName": "Alice B. Smith",
71       "displayName": "Alice Smith",
72       "displayNameLastFirst": "Smith, Alice",
73       "bestEmail": "alice.smith@acmecorp.com"
74     },
75     "modifyUser": {
76       "userGk": 1002,
77       "guid": "22222222-3333-4444-5555-666666666666",
78       "salutation": {
79         "id": 1,
80         "name": "Mr."
81       },
82       "firstName": "Bob",
83       "middleName": "C.",
84       "lastName": "Johnson",
85       "nickname": "Bobby",
86       "email": "bob.johnson@acmecorp.com",
87       "workEmail": "b.johnson@acmecorp.com",
88       "type": {
89         "id": 1,
90         "name": "Employee"
91       },
92       "companyGk": 5678,
93       "companyName": "Acme Corporation",
94       "companyGuid": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
95       "createUserGk": 1000,
96       "modifyUserGk": 1000,
97       "username": "bjohnson",
98       "avatarUrl": "https://acmecorp.com/avatars/bjohnson.png",
99       "timezoneId": 5,
100       "localeId": 1033,
101       "statusId": 1,
102       "displayFullName": "Bob C. Johnson",
103       "displayName": "Bob Johnson",
104       "displayNameLastFirst": "Johnson, Bob",
105       "bestEmail": "bob.johnson@acmecorp.com"
106     },
107     "createDate": "2023-11-01T09:15:00Z",
108     "modifyDate": "2024-04-10T14:45:00Z",
109     "themeGk": 10,
110     "lookDate": "2024-04-10T14:45:00Z",
111     "unsubscribeDate": null,
112     "delegates": [],
113     "emailSignature": "Best regards,\nJohn Doe",
114     "title": "Senior Account Manager",
115     "department": "Sales",
116     "workEnvironment": "Office",
117     "location": {
118       "address1": "123 Main St",
119       "address2": "Suite 400",
120       "city": "Metropolis",
121       "state": {
122         "id": 12,
123         "name": "California",
124         "country": {
125           "id": 1,
126           "name": "United States",
127           "countryCode": "US"
128         },
129         "abbr": "CA"
130       },
131       "postalCode": "90210",
132       "country": {
133         "id": 1,
134         "name": "United States",
135         "countryCode": "US"
136       }
137     },
138     "address": "123 Main St, Suite 400",
139     "address2": "",
140     "city": "Metropolis",
141     "state": {
142       "id": 12,
143       "name": "California",
144       "country": {
145         "id": 1,
146         "name": "United States",
147         "countryCode": "US"
148       },
149       "abbr": "CA"
150     },
151     "postalCode": "90210",
152     "country": "United States",
153     "client": {
154       "guid": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
155       "statusId": 1,
156       "clientGk": 7890,
157       "companyName": "Acme Corporation",
158       "website": "https://www.acmecorp.com",
159       "billAddress1": "123 Billing Rd",
160       "billAddress2": "Floor 2",
161       "billCity": "Metropolis",
162       "billState": {
163         "id": 12,
164         "name": "California",
165         "country": {
166           "id": 1,
167           "name": "United States",
168           "countryCode": "US"
169         },
170         "abbr": "CA"
171       },
172       "billCountry": "United States",
173       "billPostalCode": "90210",
174       "discountPercentage": 5,
175       "discountFee": 100,
176       "companyGk": 5678,
177       "stockSymbol": "ACME",
178       "companyInfo": "Leading provider of industrial products.",
179       "workgroup": {
180         "id": 3,
181         "name": "Sales Team",
182         "createUser": null,
183         "createDate": "2020-01-15T08:00:00Z",
184         "assignedMembers": []
185       },
186       "createDate": "2010-05-20T10:00:00Z",
187       "modifyDate": "2024-01-10T12:00:00Z",
188       "createUser": null,
189       "modifyUser": null,
190       "legacyId": "ACME-001",
191       "overrideEeoc": false,
192       "overrideVeteranStatus": false,
193       "overrideDisabledStatus": false,
194       "overrideJobBoardCompany": false,
195       "createMain": true,
196       "offices": [],
197       "backOfficeTerm": null,
198       "accountName": "Acme Corp Account",
199       "primarySalesUser": null,
200       "additionSalesUsers": [],
201       "showOverrideEEOC": false,
202       "udfSections": [],
203       "showUdfSections": true,
204       "customer": null,
205       "mainPhones": [],
206       "tags": []
207     },
208     "clientOffice": {
209       "officeGk": 3456,
210       "guid": "d4e5f6a7-b8c9-0123-4567-89abcdef0123",
211       "name": "Acme West Coast Office",
212       "location": {
213         "address1": "456 West St",
214         "address2": "Suite 100",
215         "city": "Metropolis",
216         "state": {
217           "id": 12,
218           "name": "California",
219           "country": {
220             "id": 1,
221             "name": "United States",
222             "countryCode": "US"
223           },
224           "abbr": "CA"
225         },
226         "postalCode": "90211",
227         "country": {
228           "id": 1,
229           "name": "United States",
230           "countryCode": "US"
231         }
232       },
233       "address": "456 West St, Suite 100",
234       "address2": "",
235       "city": "Metropolis",
236       "state": {
237         "id": 12,
238         "name": "California",
239         "country": {
240           "id": 1,
241           "name": "United States",
242           "countryCode": "US"
243         },
244         "abbr": "CA"
245       },
246       "postalCode": "90211",
247       "phones": [],
248       "client": null,
249       "createDate": "2015-06-01T09:00:00Z",
250       "modifyDate": "2023-12-01T15:00:00Z",
251       "createUser": null,
252       "modifyUser": null,
253       "primarySalesUser": null,
254       "primary": true,
255       "statusId": 1,
256       "customer": null,
257       "accountName": "Acme West Coast Account",
258       "backOfficeTerm": null,
259       "additionSalesUsers": [],
260       "udfSections": []
261     },
262     "clientGk": 7890,
263     "clientGuid": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
264     "clientName": "Acme Corporation",
265     "clientOfficeGk": 3456,
266     "clientOfficeName": "Acme West Coast Office",
267     "employeeGk": 1001,
268     "employeeOfficeGk": 3456,
269     "emailAllowed": true,
270     "smsAllowed": false,
271     "salesPerson": {
272       "userGk": 1001,
273       "guid": "11111111-2222-3333-4444-555555555555",
274       "salutation": {
275         "id": 2,
276         "name": "Ms."
277       },
278       "firstName": "Alice",
279       "middleName": "B.",
280       "lastName": "Smith",
281       "nickname": "Ally",
282       "email": "alice.smith@acmecorp.com",
283       "workEmail": "a.smith@acmecorp.com",
284       "type": {
285         "id": 1,
286         "name": "Employee"
287       },
288       "companyGk": 5678,
289       "companyName": "Acme Corporation",
290       "companyGuid": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
291       "createUserGk": 1000,
292       "modifyUserGk": 1000,
293       "username": "asmith",
294       "avatarUrl": "https://acmecorp.com/avatars/asmith.png",
295       "timezoneId": 5,
296       "localeId": 1033,
297       "statusId": 1,
298       "phones": [],
299       "primary": true,
300       "createUser": null,
301       "modifyUser": null,
302       "createDate": "2020-01-15T08:00:00Z",
303       "modifyDate": "2024-01-10T12:00:00Z",
304       "themeGk": 10,
305       "lookDate": "2024-01-10T12:00:00Z",
306       "unsubscribeDate": null,
307       "delegates": [],
308       "emailSignature": "Regards,\nAlice Smith",
309       "name": "Alice Smith",
310       "displayFullName": "Alice B. Smith",
311       "displayName": "Alice Smith",
312       "displayNameLastFirst": "Smith, Alice",
313       "bestEmail": "alice.smith@acmecorp.com"
314     },
315     "additionalSalesPersons": [],
316     "territory": {
317       "id": 7,
318       "name": "West Coast",
319       "companyGk": 5678,
320       "sortOrder": 1,
321       "choice": true
322     },
323     "salesAccountType": {
324       "id": 2,
325       "name": "Corporate"
326     },
327     "contactStatus": {
328       "id": 1,
329       "name": "Active",
330       "companyGk": 5678,
331       "sortOrder": 1,
332       "choice": true,
333       "defaultContactStatus": true
334     },
335     "udfSections": [],
336     "approvers": [],
337     "tags": [
338       {
339         "tagGk": 101,
340         "text": "Priority",
341         "companyGk": 5678,
342         "entityType": "3"
343       }
344     ],
345     "linkedApplicant": null,
346     "personalData": {
347       "id": 1,
348       "name": "Consent Given",
349       "description": "User has given consent for data processing."
350     },
351     "contactName": "John A. Doe",
352     "workbenchAccess": true,
353     "contactId": 10234,
354     "name": "John Doe",
355     "displayFullName": "John A. Doe",
356     "displayName": "John Doe",
357     "displayNameLastFirst": "Doe, John",
358     "bestEmail": "john.doe@acmecorp.com"
359   }
360 ]

Get the List of Contacts searching Contact, Office, and Client name.

Query parameters

namestringRequired

List Contacts by Search

Headers

Query parameters

Response