List Office Employees

GET

List of all Employees in a Company Office.

Path parameters

guidstringRequired

Headers

X-Brightmove-User-ApiKeystringRequired

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

employeeGKlongOptional

salesRepbooleanOptional

recruiterbooleanOptional

sourcerbooleanOptional

officeNamestringOptional

locationobjectOptional

addressstringOptional

address2stringOptional

stateobjectOptional

citystringOptional

zipstringOptional

countrystringOptional

payrollHourlyRatedoubleOptional

approverbooleanOptional

managerobjectOptional

statusenumOptional

Allowed values: NONEACTIVEINACTIVETOMBSTONE

sendDigestEmailbooleanOptional

ssoDisabledbooleanOptional

enabledTwoFactorbooleanOptional

remoteAtsIdstringOptional

lastAccessdatetimeOptional

officeobjectOptional

employeeIdstringOptional

subordinateslist of objectsOptional

securityRoleslist of objectsOptional

namestringOptional

displayFullNamestringOptional

displayNameLastFirststringOptional

bestEmailstringOptional

displayNamestringOptional

GET

1 curl https://app.brightmove.com/ATS/app/company/office/employees/guid

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       "displayFullName": "displayFullName",
56       "displayNameLastFirst": "displayNameLastFirst",
57       "bestEmail": "bestEmail",
58       "displayName": "displayName"
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       "displayFullName": "displayFullName",
83       "displayNameLastFirst": "displayNameLastFirst",
84       "bestEmail": "bestEmail",
85       "displayName": "displayName"
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     "employeeGK": 1000000,
97     "salesRep": true,
98     "recruiter": true,
99     "sourcer": true,
100     "officeName": "officeName",
101     "location": {
102       "address1": "address1",
103       "address2": "address2",
104       "city": "city",
105       "state": {
106         "id": 1000000
107       },
108       "postalCode": "postalCode",
109       "country": {
110         "id": 1000000
111       }
112     },
113     "address": "address",
114     "address2": "address2",
115     "state": {
116       "id": 1000000,
117       "name": "name",
118       "country": {
119         "id": 1000000
120       },
121       "abbr": "abbr"
122     },
123     "city": "city",
124     "zip": "zip",
125     "country": "country",
126     "payrollHourlyRate": 1.1,
127     "approver": true,
128     "manager": {
129       "userGk": 1000000,
130       "guid": "guid",
131       "salutation": {
132         "id": 1000000
133       },
134       "firstName": "firstName",
135       "middleName": "middleName",
136       "lastName": "lastName",
137       "nickname": "nickname",
138       "email": "email",
139       "workEmail": "workEmail",
140       "companyGk": 1000000,
141       "companyName": "companyName",
142       "companyGuid": "companyGuid",
143       "createUserGk": 1000000,
144       "modifyUserGk": 1000000,
145       "username": "username",
146       "avatarUrl": "avatarUrl",
147       "timezoneId": 1,
148       "localeId": 1,
149       "statusId": 1,
150       "phones": [
151         {}
152       ],
153       "primary": true,
154       "createDate": "2024-01-15T09:30:00Z",
155       "modifyDate": "2024-01-15T09:30:00Z",
156       "themeGk": 1000000,
157       "lookDate": "2024-01-15T09:30:00Z",
158       "unsubscribeDate": "2024-01-15T09:30:00Z",
159       "delegates": [
160         {}
161       ],
162       "emailSignature": "emailSignature",
163       "name": "name",
164       "displayFullName": "displayFullName",
165       "displayNameLastFirst": "displayNameLastFirst",
166       "bestEmail": "bestEmail",
167       "displayName": "displayName"
168     },
169     "status": "NONE",
170     "sendDigestEmail": true,
171     "ssoDisabled": true,
172     "enabledTwoFactor": true,
173     "remoteAtsId": "remoteAtsId",
174     "lastAccess": "2024-01-15T09:30:00Z",
175     "office": {
176       "officeGk": 1000000,
177       "guid": "guid",
178       "name": "name",
179       "address": "address",
180       "address2": "address2",
181       "city": "city",
182       "state": {
183         "id": 1000000
184       },
185       "postalCode": "postalCode",
186       "phones": [
187         {}
188       ],
189       "createDate": "2024-01-15T09:30:00Z",
190       "modifyDate": "2024-01-15T09:30:00Z",
191       "costCenter": "costCenter",
192       "email": "email",
193       "country": "country"
194     },
195     "employeeId": "employeeId",
196     "subordinates": [
197       {}
198     ],
199     "securityRoles": [
200       {}
201     ],
202     "name": "name",
203     "displayFullName": "displayFullName",
204     "displayNameLastFirst": "displayNameLastFirst",
205     "bestEmail": "bestEmail",
206     "displayName": "displayName"
207   }
208 ]

Get Company Office

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	"displayFullName": "displayFullName",
56	"displayNameLastFirst": "displayNameLastFirst",
57	"bestEmail": "bestEmail",
58	"displayName": "displayName"
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	"displayFullName": "displayFullName",
83	"displayNameLastFirst": "displayNameLastFirst",
84	"bestEmail": "bestEmail",
85	"displayName": "displayName"
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	"employeeGK": 1000000,
97	"salesRep": true,
98	"recruiter": true,
99	"sourcer": true,
100	"officeName": "officeName",
101	"location": {
102	"address1": "address1",
103	"address2": "address2",
104	"city": "city",
105	"state": {
106	"id": 1000000
107	},
108	"postalCode": "postalCode",
109	"country": {
110	"id": 1000000
111	}
112	},
113	"address": "address",
114	"address2": "address2",
115	"state": {
116	"id": 1000000,
117	"name": "name",
118	"country": {
119	"id": 1000000
120	},
121	"abbr": "abbr"
122	},
123	"city": "city",
124	"zip": "zip",
125	"country": "country",
126	"payrollHourlyRate": 1.1,
127	"approver": true,
128	"manager": {
129	"userGk": 1000000,
130	"guid": "guid",
131	"salutation": {
132	"id": 1000000
133	},
134	"firstName": "firstName",
135	"middleName": "middleName",
136	"lastName": "lastName",
137	"nickname": "nickname",
138	"email": "email",
139	"workEmail": "workEmail",
140	"companyGk": 1000000,
141	"companyName": "companyName",
142	"companyGuid": "companyGuid",
143	"createUserGk": 1000000,
144	"modifyUserGk": 1000000,
145	"username": "username",
146	"avatarUrl": "avatarUrl",
147	"timezoneId": 1,
148	"localeId": 1,
149	"statusId": 1,
150	"phones": [
151	{}
152	],
153	"primary": true,
154	"createDate": "2024-01-15T09:30:00Z",
155	"modifyDate": "2024-01-15T09:30:00Z",
156	"themeGk": 1000000,
157	"lookDate": "2024-01-15T09:30:00Z",
158	"unsubscribeDate": "2024-01-15T09:30:00Z",
159	"delegates": [
160	{}
161	],
162	"emailSignature": "emailSignature",
163	"name": "name",
164	"displayFullName": "displayFullName",
165	"displayNameLastFirst": "displayNameLastFirst",
166	"bestEmail": "bestEmail",
167	"displayName": "displayName"
168	},
169	"status": "NONE",
170	"sendDigestEmail": true,
171	"ssoDisabled": true,
172	"enabledTwoFactor": true,
173	"remoteAtsId": "remoteAtsId",
174	"lastAccess": "2024-01-15T09:30:00Z",
175	"office": {
176	"officeGk": 1000000,
177	"guid": "guid",
178	"name": "name",
179	"address": "address",
180	"address2": "address2",
181	"city": "city",
182	"state": {
183	"id": 1000000
184	},
185	"postalCode": "postalCode",
186	"phones": [
187	{}
188	],
189	"createDate": "2024-01-15T09:30:00Z",
190	"modifyDate": "2024-01-15T09:30:00Z",
191	"costCenter": "costCenter",
192	"email": "email",
193	"country": "country"
194	},
195	"employeeId": "employeeId",
196	"subordinates": [
197	{}
198	],
199	"securityRoles": [
200	{}
201	],
202	"name": "name",
203	"displayFullName": "displayFullName",
204	"displayNameLastFirst": "displayNameLastFirst",
205	"bestEmail": "bestEmail",
206	"displayName": "displayName"
207	}
208	]