List Company Employees

GET

https://app.brightmove.com/ATS/app/employee/list

GET

/ATS/app/employee/list

1 import requests
2 
3 url = "https://app.brightmove.com/ATS/app/employee/list"
4 
5 payload = {}
6 headers = {"Content-Type": "application/json"}
7 
8 response = requests.get(url, json=payload, headers=headers)
9 
10 print(response.json())

200Retrieved

1 [
2   {
3     "userGk": 10234,
4     "guid": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
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@example.com",
14     "workEmail": "j.doe@company.com",
15     "type": {
16       "id": 2,
17       "name": "Employee"
18     },
19     "companyGk": 5678,
20     "companyName": "BrightMove Inc.",
21     "companyGuid": "f1e2d3c4-b5a6-7890-cdef-0987654321ab",
22     "createUserGk": 10001,
23     "modifyUserGk": 10002,
24     "username": "jdoe",
25     "avatarUrl": "https://company.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": "Mobile",
36           "sortOrder": 1,
37           "choice": true
38         },
39         "userGk": 10234
40       }
41     ],
42     "primary": true,
43     "createUser": {
44       "userGk": 10001,
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@example.com",
55       "workEmail": "a.smith@company.com",
56       "type": {
57         "id": 1,
58         "name": "Admin"
59       },
60       "companyGk": 5678,
61       "companyName": "BrightMove Inc.",
62       "companyGuid": "f1e2d3c4-b5a6-7890-cdef-0987654321ab",
63       "createUserGk": 0,
64       "modifyUserGk": 0,
65       "username": "asmith",
66       "avatarUrl": "https://company.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@example.com"
74     },
75     "modifyUser": {
76       "userGk": 10002,
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@example.com",
87       "workEmail": "b.johnson@company.com",
88       "type": {
89         "id": 1,
90         "name": "Admin"
91       },
92       "companyGk": 5678,
93       "companyName": "BrightMove Inc.",
94       "companyGuid": "f1e2d3c4-b5a6-7890-cdef-0987654321ab",
95       "createUserGk": 0,
96       "modifyUserGk": 0,
97       "username": "bjohnson",
98       "avatarUrl": "https://company.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@example.com"
106     },
107     "createDate": "2023-01-15T08:30:00Z",
108     "modifyDate": "2024-04-10T12:45:00Z",
109     "themeGk": 3,
110     "lookDate": "2024-04-10T12:45:00Z",
111     "unsubscribeDate": null,
112     "delegates": [],
113     "emailSignature": "Best regards,\nJohn Doe\nBrightMove Inc.",
114     "employeeGK": 10234,
115     "salesRep": false,
116     "recruiter": true,
117     "sourcer": false,
118     "officeName": "Headquarters",
119     "location": {
120       "address1": "123 Main St",
121       "address2": "Suite 400",
122       "city": "Austin",
123       "state": {
124         "id": 48,
125         "name": "Texas",
126         "country": {
127           "id": 1,
128           "name": "United States",
129           "countryCode": "US"
130         },
131         "abbr": "TX"
132       },
133       "postalCode": "78701",
134       "country": {
135         "id": 1,
136         "name": "United States",
137         "countryCode": "US"
138       }
139     },
140     "address": "123 Main St, Suite 400",
141     "address2": "",
142     "state": {
143       "id": 48,
144       "name": "Texas",
145       "country": {
146         "id": 1,
147         "name": "United States",
148         "countryCode": "US"
149       },
150       "abbr": "TX"
151     },
152     "city": "Austin",
153     "zip": "78701",
154     "country": "USA",
155     "payrollHourlyRate": 35.5,
156     "approver": true,
157     "manager": {
158       "userGk": 10100,
159       "guid": "99999999-8888-7777-6666-555555555555",
160       "salutation": {
161         "id": 1,
162         "name": "Mr."
163       },
164       "firstName": "Michael",
165       "middleName": "D.",
166       "lastName": "Scott",
167       "nickname": "Mike",
168       "email": "michael.scott@company.com",
169       "workEmail": "m.scott@company.com",
170       "type": {
171         "id": 2,
172         "name": "Manager"
173       },
174       "companyGk": 5678,
175       "companyName": "BrightMove Inc.",
176       "companyGuid": "f1e2d3c4-b5a6-7890-cdef-0987654321ab",
177       "createUserGk": 10001,
178       "modifyUserGk": 10002,
179       "username": "mscott",
180       "avatarUrl": "https://company.com/avatars/mscott.png",
181       "timezoneId": 5,
182       "localeId": 1033,
183       "statusId": 1,
184       "phones": [],
185       "primary": true,
186       "createUser": null,
187       "modifyUser": null,
188       "createDate": "2020-05-01T09:00:00Z",
189       "modifyDate": "2024-01-10T10:00:00Z",
190       "themeGk": 1,
191       "lookDate": "2024-01-10T10:00:00Z",
192       "unsubscribeDate": null,
193       "delegates": [],
194       "emailSignature": "Regards,\nMichael Scott",
195       "name": "Michael Scott",
196       "displayFullName": "Michael D. Scott",
197       "displayName": "Michael Scott",
198       "displayNameLastFirst": "Scott, Michael",
199       "bestEmail": "michael.scott@company.com"
200     },
201     "status": "ACTIVE",
202     "sendDigestEmail": true,
203     "ssoDisabled": false,
204     "enabledTwoFactor": true,
205     "remoteAtsId": "RM123456789",
206     "lastAccess": "2024-04-20T15:20:00Z",
207     "office": {
208       "officeGk": 3001,
209       "guid": "office-1234-5678-9012-345678901234",
210       "name": "BrightMove Headquarters",
211       "location": {
212         "address1": "123 Main St",
213         "address2": "Suite 400",
214         "city": "Austin",
215         "state": {
216           "id": 48,
217           "name": "Texas",
218           "country": {
219             "id": 1,
220             "name": "United States",
221             "countryCode": "US"
222           },
223           "abbr": "TX"
224         },
225         "postalCode": "78701",
226         "country": {
227           "id": 1,
228           "name": "United States",
229           "countryCode": "US"
230         }
231       },
232       "address": "123 Main St, Suite 400",
233       "address2": "",
234       "city": "Austin",
235       "state": {
236         "id": 48,
237         "name": "Texas",
238         "country": {
239           "id": 1,
240           "name": "United States",
241           "countryCode": "US"
242         },
243         "abbr": "TX"
244       },
245       "postalCode": "78701",
246       "phones": [],
247       "createDate": "2019-11-01T08:00:00Z",
248       "modifyDate": "2024-02-15T09:30:00Z",
249       "costCenter": "CC1001",
250       "createUser": null,
251       "modifyUser": null,
252       "email": "hq@brightmove.com",
253       "country": "USA"
254     },
255     "employeeId": "EMP-10234",
256     "subordinates": [],
257     "securityRoles": [
258       {
259         "value": 101,
260         "label": "Recruiter"
261       },
262       {
263         "value": 102,
264         "label": "HR"
265       }
266     ],
267     "name": "John A. Doe",
268     "displayFullName": "John A. Doe",
269     "displayName": "John Doe",
270     "displayNameLastFirst": "Doe, John",
271     "bestEmail": "john.doe@example.com"
272   }
273 ]

List all Active Company Employees

List Company Employees

Headers

Response