List All Folders By Type

GET

https://app.brightmove.com/ATS/app/folder/list/all/:entityType

GET

/ATS/app/folder/list/all/:entityType

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

1 [
2   {
3     "folderGk": 10234,
4     "folderName": "Engineering Team Documents",
5     "shared": true,
6     "owned": false,
7     "createDate": "2024-05-10T09:15:00Z",
8     "owner": {
9       "userGk": 501,
10       "guid": "a3f1c9d2-7b4e-4f8a-9c2d-1e2f3a4b5c6d",
11       "salutation": {
12         "id": 1,
13         "name": "Mr."
14       },
15       "firstName": "James",
16       "middleName": "A.",
17       "lastName": "Smith",
18       "nickname": "Jim",
19       "email": "james.smith@example.com",
20       "workEmail": "j.smith@brightmove.com",
21       "type": {
22         "id": 2,
23         "name": "Employee"
24       },
25       "companyGk": 1001,
26       "companyName": "BrightMove Inc.",
27       "companyGuid": "c9b1d2e3-f4a5-6789-b0cd-ef1234567890",
28       "createUserGk": 501,
29       "modifyUserGk": 502,
30       "username": "jsmith",
31       "avatarUrl": "https://cdn.brightmove.com/avatars/jsmith.png",
32       "timezoneId": 5,
33       "localeId": 1033,
34       "statusId": 1,
35       "phones": [
36         {
37           "id": 301,
38           "phoneNumber": "+1-555-123-4567",
39           "type": {
40             "id": 1,
41             "name": "Mobile",
42             "sortOrder": 1,
43             "choice": true
44           },
45           "userGk": 501
46         }
47       ],
48       "primary": true,
49       "createUser": {
50         "userGk": 500,
51         "guid": "b2c3d4e5-f6a7-8901-b2cd-ef3456789012",
52         "salutation": {
53           "id": 2,
54           "name": "Ms."
55         },
56         "firstName": "Laura",
57         "middleName": "B.",
58         "lastName": "Jones",
59         "nickname": "Laurie",
60         "email": "laura.jones@example.com",
61         "workEmail": "l.jones@brightmove.com",
62         "type": {
63           "id": 3,
64           "name": "Admin"
65         },
66         "companyGk": 1001,
67         "companyName": "BrightMove Inc.",
68         "companyGuid": "c9b1d2e3-f4a5-6789-b0cd-ef1234567890",
69         "createUserGk": 500,
70         "modifyUserGk": 500,
71         "username": "ljones",
72         "avatarUrl": "https://cdn.brightmove.com/avatars/ljones.png",
73         "timezoneId": 5,
74         "localeId": 1033,
75         "statusId": 1,
76         "displayFullName": "Laura B. Jones",
77         "displayName": "Laura Jones",
78         "displayNameLastFirst": "Jones, Laura",
79         "bestEmail": "laura.jones@example.com"
80       },
81       "modifyUser": {
82         "userGk": 502,
83         "guid": "d4e5f6a7-8901-b2cd-ef34-56789012abcd",
84         "salutation": {
85           "id": 1,
86           "name": "Mr."
87         },
88         "firstName": "Michael",
89         "middleName": "C.",
90         "lastName": "Brown",
91         "nickname": "Mike",
92         "email": "michael.brown@example.com",
93         "workEmail": "m.brown@brightmove.com",
94         "type": {
95           "id": 2,
96           "name": "Employee"
97         },
98         "companyGk": 1001,
99         "companyName": "BrightMove Inc.",
100         "companyGuid": "c9b1d2e3-f4a5-6789-b0cd-ef1234567890",
101         "createUserGk": 500,
102         "modifyUserGk": 502,
103         "username": "mbrown",
104         "avatarUrl": "https://cdn.brightmove.com/avatars/mbrown.png",
105         "timezoneId": 5,
106         "localeId": 1033,
107         "statusId": 1,
108         "displayFullName": "Michael C. Brown",
109         "displayName": "Michael Brown",
110         "displayNameLastFirst": "Brown, Michael",
111         "bestEmail": "michael.brown@example.com"
112       },
113       "createDate": "2023-11-01T08:00:00Z",
114       "modifyDate": "2024-04-20T15:45:00Z",
115       "themeGk": 10,
116       "lookDate": "2024-05-01T00:00:00Z",
117       "unsubscribeDate": null,
118       "delegates": [],
119       "emailSignature": "Best regards,\nJames Smith\nBrightMove Inc.",
120       "name": "James Smith",
121       "displayFullName": "James A. Smith",
122       "displayName": "James Smith",
123       "displayNameLastFirst": "Smith, James",
124       "bestEmail": "james.smith@example.com"
125     },
126     "entityType": {
127       "id": 1,
128       "name": "Candidate"
129     },
130     "memberCount": 12
131   },
132   {
133     "folderGk": 10235,
134     "folderName": "Marketing Campaigns",
135     "shared": false,
136     "owned": true,
137     "createDate": "2024-01-15T11:30:00Z",
138     "owner": {
139       "userGk": 502,
140       "guid": "d4e5f6a7-8901-b2cd-ef34-56789012abcd",
141       "salutation": {
142         "id": 1,
143         "name": "Mr."
144       },
145       "firstName": "Michael",
146       "middleName": "C.",
147       "lastName": "Brown",
148       "nickname": "Mike",
149       "email": "michael.brown@example.com",
150       "workEmail": "m.brown@brightmove.com",
151       "type": {
152         "id": 2,
153         "name": "Employee"
154       },
155       "companyGk": 1001,
156       "companyName": "BrightMove Inc.",
157       "companyGuid": "c9b1d2e3-f4a5-6789-b0cd-ef1234567890",
158       "createUserGk": 500,
159       "modifyUserGk": 502,
160       "username": "mbrown",
161       "avatarUrl": "https://cdn.brightmove.com/avatars/mbrown.png",
162       "timezoneId": 5,
163       "localeId": 1033,
164       "statusId": 1,
165       "phones": [
166         {
167           "id": 302,
168           "phoneNumber": "+1-555-987-6543",
169           "type": {
170             "id": 2,
171             "name": "Work",
172             "sortOrder": 2,
173             "choice": true
174           },
175           "userGk": 502
176         }
177       ],
178       "primary": true,
179       "createUser": {
180         "userGk": 500,
181         "guid": "b2c3d4e5-f6a7-8901-b2cd-ef3456789012",
182         "salutation": {
183           "id": 2,
184           "name": "Ms."
185         },
186         "firstName": "Laura",
187         "middleName": "B.",
188         "lastName": "Jones",
189         "nickname": "Laurie",
190         "email": "laura.jones@example.com",
191         "workEmail": "l.jones@brightmove.com",
192         "type": {
193           "id": 3,
194           "name": "Admin"
195         },
196         "companyGk": 1001,
197         "companyName": "BrightMove Inc.",
198         "companyGuid": "c9b1d2e3-f4a5-6789-b0cd-ef1234567890",
199         "createUserGk": 500,
200         "modifyUserGk": 500,
201         "username": "ljones",
202         "avatarUrl": "https://cdn.brightmove.com/avatars/ljones.png",
203         "timezoneId": 5,
204         "localeId": 1033,
205         "statusId": 1,
206         "displayFullName": "Laura B. Jones",
207         "displayName": "Laura Jones",
208         "displayNameLastFirst": "Jones, Laura",
209         "bestEmail": "laura.jones@example.com"
210       },
211       "modifyUser": {
212         "userGk": 502,
213         "guid": "d4e5f6a7-8901-b2cd-ef34-56789012abcd",
214         "salutation": {
215           "id": 1,
216           "name": "Mr."
217         },
218         "firstName": "Michael",
219         "middleName": "C.",
220         "lastName": "Brown",
221         "nickname": "Mike",
222         "email": "michael.brown@example.com",
223         "workEmail": "m.brown@brightmove.com",
224         "type": {
225           "id": 2,
226           "name": "Employee"
227         },
228         "companyGk": 1001,
229         "companyName": "BrightMove Inc.",
230         "companyGuid": "c9b1d2e3-f4a5-6789-b0cd-ef1234567890",
231         "createUserGk": 500,
232         "modifyUserGk": 502,
233         "username": "mbrown",
234         "avatarUrl": "https://cdn.brightmove.com/avatars/mbrown.png",
235         "timezoneId": 5,
236         "localeId": 1033,
237         "statusId": 1,
238         "displayFullName": "Michael C. Brown",
239         "displayName": "Michael Brown",
240         "displayNameLastFirst": "Brown, Michael",
241         "bestEmail": "michael.brown@example.com"
242       },
243       "createDate": "2023-11-01T08:00:00Z",
244       "modifyDate": "2024-04-20T15:45:00Z",
245       "themeGk": 10,
246       "lookDate": "2024-05-01T00:00:00Z",
247       "unsubscribeDate": null,
248       "delegates": [],
249       "emailSignature": "Best regards,\nMichael Brown\nBrightMove Inc.",
250       "name": "Michael Brown",
251       "displayFullName": "Michael C. Brown",
252       "displayName": "Michael Brown",
253       "displayNameLastFirst": "Brown, Michael",
254       "bestEmail": "michael.brown@example.com"
255     },
256     "entityType": {
257       "id": 1,
258       "name": "Candidate"
259     },
260     "memberCount": 8
261   }
262 ]

Get a List of All Folders by Entity Type

Path parameters

entityTypeintegerRequired

List All Folders By Type

Path parameters

Headers

Response