List Contacts For Client

GET

https://app.brightmove.com/ATS/app/contact/list/:clientGk/:query/

GET

/ATS/app/contact/list/:clientGk/:query/

1 curl https://app.brightmove.com/ATS/app/contact/list/0/query/

Try it

200Retrieved

1 [
2   {
3     "userGk": 0,
4     "guid": "guid",
5     "salutation": {
6       "id": 0,
7       "name": "name"
8     },
9     "firstName": "firstName",
10     "middleName": "middleName",
11     "lastName": "lastName",
12     "nickname": "nickname",
13     "email": "email",
14     "workEmail": "workEmail",
15     "type": {
16       "id": 0,
17       "name": "name"
18     },
19     "companyGk": 0,
20     "companyName": "companyName",
21     "companyGuid": "companyGuid",
22     "createUserGk": 0,
23     "modifyUserGk": 0,
24     "username": "username",
25     "avatarUrl": "avatarUrl",
26     "timezoneId": 0,
27     "localeId": 0,
28     "statusId": 0,
29     "phones": [
30       {
31         "id": 0,
32         "phoneNumber": "phoneNumber",
33         "type": {
34           "id": 0,
35           "name": "name",
36           "sortOrder": 0,
37           "choice": false
38         },
39         "userGk": 0
40       }
41     ],
42     "primary": false,
43     "createUser": {
44       "userGk": 0,
45       "guid": "guid",
46       "salutation": {
47         "id": 0,
48         "name": "name"
49       },
50       "firstName": "firstName",
51       "middleName": "middleName",
52       "lastName": "lastName",
53       "nickname": "nickname",
54       "email": "email",
55       "workEmail": "workEmail",
56       "type": {
57         "id": 0,
58         "name": "name"
59       },
60       "companyGk": 0,
61       "companyName": "companyName",
62       "companyGuid": "companyGuid",
63       "createUserGk": 0,
64       "modifyUserGk": 0,
65       "username": "username",
66       "avatarUrl": "avatarUrl",
67       "timezoneId": 0,
68       "localeId": 0,
69       "statusId": 0,
70       "displayNameLastFirst": "displayNameLastFirst",
71       "displayFullName": "displayFullName",
72       "displayName": "displayName",
73       "bestEmail": "bestEmail"
74     },
75     "modifyUser": {
76       "userGk": 0,
77       "guid": "guid",
78       "salutation": {
79         "id": 0,
80         "name": "name"
81       },
82       "firstName": "firstName",
83       "middleName": "middleName",
84       "lastName": "lastName",
85       "nickname": "nickname",
86       "email": "email",
87       "workEmail": "workEmail",
88       "type": {
89         "id": 0,
90         "name": "name"
91       },
92       "companyGk": 0,
93       "companyName": "companyName",
94       "companyGuid": "companyGuid",
95       "createUserGk": 0,
96       "modifyUserGk": 0,
97       "username": "username",
98       "avatarUrl": "avatarUrl",
99       "timezoneId": 0,
100       "localeId": 0,
101       "statusId": 0,
102       "displayNameLastFirst": "displayNameLastFirst",
103       "displayFullName": "displayFullName",
104       "displayName": "displayName",
105       "bestEmail": "bestEmail"
106     },
107     "createDate": "createDate",
108     "modifyDate": "modifyDate",
109     "themeGk": 0,
110     "lookDate": "lookDate",
111     "unsubscribeDate": "unsubscribeDate",
112     "delegates": [
113       {
114         "userGk": 0,
115         "guid": "guid",
116         "salutation": {
117           "id": 0,
118           "name": "name"
119         },
120         "firstName": "firstName",
121         "middleName": "middleName",
122         "lastName": "lastName",
123         "nickname": "nickname",
124         "email": "email",
125         "workEmail": "workEmail",
126         "type": {
127           "id": 0,
128           "name": "name"
129         },
130         "companyGk": 0,
131         "companyName": "companyName",
132         "companyGuid": "companyGuid",
133         "createUserGk": 0,
134         "modifyUserGk": 0,
135         "username": "username",
136         "avatarUrl": "avatarUrl",
137         "timezoneId": 0,
138         "localeId": 0,
139         "statusId": 0,
140         "phones": [
141           {
142             "id": 0,
143             "phoneNumber": "phoneNumber",
144             "type": {
145               "id": 0,
146               "name": "name",
147               "sortOrder": 0,
148               "choice": false
149             },
150             "userGk": 0
151           }
152         ],
153         "primary": false,
154         "createUser": {
155           "userGk": 0,
156           "guid": "guid",
157           "salutation": {
158             "id": 0,
159             "name": "name"
160           },
161           "firstName": "firstName",
162           "middleName": "middleName",
163           "lastName": "lastName",
164           "nickname": "nickname",
165           "email": "email",
166           "workEmail": "workEmail",
167           "type": {
168             "id": 0,
169             "name": "name"
170           },
171           "companyGk": 0,
172           "companyName": "companyName",
173           "companyGuid": "companyGuid",
174           "createUserGk": 0,
175           "modifyUserGk": 0,
176           "username": "username",
177           "avatarUrl": "avatarUrl",
178           "timezoneId": 0,
179           "localeId": 0,
180           "statusId": 0,
181           "displayNameLastFirst": "displayNameLastFirst",
182           "displayFullName": "displayFullName",
183           "displayName": "displayName",
184           "bestEmail": "bestEmail"
185         },
186         "modifyUser": {
187           "userGk": 0,
188           "guid": "guid",
189           "salutation": {
190             "id": 0,
191             "name": "name"
192           },
193           "firstName": "firstName",
194           "middleName": "middleName",
195           "lastName": "lastName",
196           "nickname": "nickname",
197           "email": "email",
198           "workEmail": "workEmail",
199           "type": {
200             "id": 0,
201             "name": "name"
202           },
203           "companyGk": 0,
204           "companyName": "companyName",
205           "companyGuid": "companyGuid",
206           "createUserGk": 0,
207           "modifyUserGk": 0,
208           "username": "username",
209           "avatarUrl": "avatarUrl",
210           "timezoneId": 0,
211           "localeId": 0,
212           "statusId": 0,
213           "displayNameLastFirst": "displayNameLastFirst",
214           "displayFullName": "displayFullName",
215           "displayName": "displayName",
216           "bestEmail": "bestEmail"
217         },
218         "createDate": "createDate",
219         "modifyDate": "modifyDate",
220         "themeGk": 0,
221         "lookDate": "lookDate",
222         "unsubscribeDate": "unsubscribeDate",
223         "emailSignature": "emailSignature",
224         "startDate": "startDate",
225         "endDate": "endDate",
226         "name": "name",
227         "displayNameLastFirst": "displayNameLastFirst",
228         "displayFullName": "displayFullName",
229         "displayName": "displayName",
230         "bestEmail": "bestEmail"
231       }
232     ],
233     "emailSignature": "emailSignature",
234     "name": "name",
235     "displayNameLastFirst": "displayNameLastFirst",
236     "displayFullName": "displayFullName",
237     "displayName": "displayName",
238     "bestEmail": "bestEmail"
239   }
240 ]

Lookup a Contact by query within a Client

Path parameters

clientGklongRequired

querystringRequired

Response

userGklongOptional

guidstringOptional

salutationobjectOptional

firstNamestringOptional

middleNamestringOptional

lastNamestringOptional

nicknamestringOptional

emailstringOptional

workEmailstringOptional

typeobjectOptional

companyGklongOptional

companyNamestringOptional

companyGuidstringOptional

createUserGklongOptional

modifyUserGklongOptional

usernamestringOptional

avatarUrlstringOptional

timezoneIdintegerOptional

localeIdintegerOptional

statusIdintegerOptional

phoneslist of objectsOptional

primarybooleanOptional

createUserobjectOptional

modifyUserobjectOptional

createDatedatetimeOptional

modifyDatedatetimeOptional

themeGklongOptional

lookDatedatetimeOptional

unsubscribeDatedatetimeOptional

delegateslist of objectsOptional

emailSignaturestringOptional

namestringOptional

displayNameLastFirststringOptional

displayFullNamestringOptional

displayNamestringOptional

bestEmailstringOptional

List Contacts For Client

Path parameters

Headers

Response

Errors