List Contacts For Client

GET

Lookup a Contact by query within a Client

Path parameters

clientGklongRequired

querystringRequired

Headers

X-Brightmove-User-ApiKeystringRequired

X-Brightmove-Company-ApiKeystringOptional

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

displayNamestringOptional

displayNameLastFirststringOptional

bestEmailstringOptional

displayFullNamestringOptional

GET

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

200Retrieved

1 [
2   {
3     "userGk": 1000000,
4     "guid": "guid",
5     "salutation": {
6       "id": 1000000,
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": 1,
17       "name": "name"
18     },
19     "companyGk": 1000000,
20     "companyName": "companyName",
21     "companyGuid": "companyGuid",
22     "createUserGk": 1000000,
23     "modifyUserGk": 1000000,
24     "username": "username",
25     "avatarUrl": "avatarUrl",
26     "timezoneId": 1,
27     "localeId": 1,
28     "statusId": 1,
29     "phones": [
30       {}
31     ],
32     "primary": true,
33     "createUser": {
34       "userGk": 1000000,
35       "guid": "guid",
36       "salutation": {
37         "id": 1000000
38       },
39       "firstName": "firstName",
40       "middleName": "middleName",
41       "lastName": "lastName",
42       "nickname": "nickname",
43       "email": "email",
44       "workEmail": "workEmail",
45       "companyGk": 1000000,
46       "companyName": "companyName",
47       "companyGuid": "companyGuid",
48       "createUserGk": 1000000,
49       "modifyUserGk": 1000000,
50       "username": "username",
51       "avatarUrl": "avatarUrl",
52       "timezoneId": 1,
53       "localeId": 1,
54       "statusId": 1,
55       "displayName": "displayName",
56       "displayNameLastFirst": "displayNameLastFirst",
57       "bestEmail": "bestEmail",
58       "displayFullName": "displayFullName"
59     },
60     "modifyUser": {
61       "userGk": 1000000,
62       "guid": "guid",
63       "salutation": {
64         "id": 1000000
65       },
66       "firstName": "firstName",
67       "middleName": "middleName",
68       "lastName": "lastName",
69       "nickname": "nickname",
70       "email": "email",
71       "workEmail": "workEmail",
72       "companyGk": 1000000,
73       "companyName": "companyName",
74       "companyGuid": "companyGuid",
75       "createUserGk": 1000000,
76       "modifyUserGk": 1000000,
77       "username": "username",
78       "avatarUrl": "avatarUrl",
79       "timezoneId": 1,
80       "localeId": 1,
81       "statusId": 1,
82       "displayName": "displayName",
83       "displayNameLastFirst": "displayNameLastFirst",
84       "bestEmail": "bestEmail",
85       "displayFullName": "displayFullName"
86     },
87     "createDate": "2024-01-15T09:30:00Z",
88     "modifyDate": "2024-01-15T09:30:00Z",
89     "themeGk": 1000000,
90     "lookDate": "2024-01-15T09:30:00Z",
91     "unsubscribeDate": "2024-01-15T09:30:00Z",
92     "delegates": [
93       {}
94     ],
95     "emailSignature": "emailSignature",
96     "name": "name",
97     "displayName": "displayName",
98     "displayNameLastFirst": "displayNameLastFirst",
99     "bestEmail": "bestEmail",
100     "displayFullName": "displayFullName"
101   }
102 ]

Get Contact

Up Next

Built with

1	[
2	{
3	"userGk": 1000000,
4	"guid": "guid",
5	"salutation": {
6	"id": 1000000,
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": 1,
17	"name": "name"
18	},
19	"companyGk": 1000000,
20	"companyName": "companyName",
21	"companyGuid": "companyGuid",
22	"createUserGk": 1000000,
23	"modifyUserGk": 1000000,
24	"username": "username",
25	"avatarUrl": "avatarUrl",
26	"timezoneId": 1,
27	"localeId": 1,
28	"statusId": 1,
29	"phones": [
30	{}
31	],
32	"primary": true,
33	"createUser": {
34	"userGk": 1000000,
35	"guid": "guid",
36	"salutation": {
37	"id": 1000000
38	},
39	"firstName": "firstName",
40	"middleName": "middleName",
41	"lastName": "lastName",
42	"nickname": "nickname",
43	"email": "email",
44	"workEmail": "workEmail",
45	"companyGk": 1000000,
46	"companyName": "companyName",
47	"companyGuid": "companyGuid",
48	"createUserGk": 1000000,
49	"modifyUserGk": 1000000,
50	"username": "username",
51	"avatarUrl": "avatarUrl",
52	"timezoneId": 1,
53	"localeId": 1,
54	"statusId": 1,
55	"displayName": "displayName",
56	"displayNameLastFirst": "displayNameLastFirst",
57	"bestEmail": "bestEmail",
58	"displayFullName": "displayFullName"
59	},
60	"modifyUser": {
61	"userGk": 1000000,
62	"guid": "guid",
63	"salutation": {
64	"id": 1000000
65	},
66	"firstName": "firstName",
67	"middleName": "middleName",
68	"lastName": "lastName",
69	"nickname": "nickname",
70	"email": "email",
71	"workEmail": "workEmail",
72	"companyGk": 1000000,
73	"companyName": "companyName",
74	"companyGuid": "companyGuid",
75	"createUserGk": 1000000,
76	"modifyUserGk": 1000000,
77	"username": "username",
78	"avatarUrl": "avatarUrl",
79	"timezoneId": 1,
80	"localeId": 1,
81	"statusId": 1,
82	"displayName": "displayName",
83	"displayNameLastFirst": "displayNameLastFirst",
84	"bestEmail": "bestEmail",
85	"displayFullName": "displayFullName"
86	},
87	"createDate": "2024-01-15T09:30:00Z",
88	"modifyDate": "2024-01-15T09:30:00Z",
89	"themeGk": 1000000,
90	"lookDate": "2024-01-15T09:30:00Z",
91	"unsubscribeDate": "2024-01-15T09:30:00Z",
92	"delegates": [
93	{}
94	],
95	"emailSignature": "emailSignature",
96	"name": "name",
97	"displayName": "displayName",
98	"displayNameLastFirst": "displayNameLastFirst",
99	"bestEmail": "bestEmail",
100	"displayFullName": "displayFullName"
101	}
102	]