List My Folders By Type

GET

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

GET

/ATS/app/folder/list/my/:entityType

1 import requests
2 
3 url = "https://app.brightmove.com/ATS/app/folder/list/my/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": 987654321,
4     "folderName": "Engineering Team Projects",
5     "shared": true,
6     "owned": true,
7     "createDate": "2024-05-10T09:15:00Z",
8     "owner": {
9       "userGk": 123456789,
10       "guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
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": 555555,
26       "companyName": "BrightMove Inc.",
27       "companyGuid": "comp-1234-5678-9012-3456",
28       "createUserGk": 111111,
29       "modifyUserGk": 222222,
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": 1001,
38           "phoneNumber": "+1-555-123-4567",
39           "type": {
40             "id": 1,
41             "name": "Mobile",
42             "sortOrder": 1,
43             "choice": true
44           },
45           "userGk": 123456789
46         }
47       ],
48       "primary": true,
49       "createUser": {
50         "userGk": 111111,
51         "guid": "11111111-2222-3333-4444-555555555555",
52         "salutation": {
53           "id": 2,
54           "name": "Ms."
55         },
56         "firstName": "Anna",
57         "middleName": "B.",
58         "lastName": "Johnson",
59         "nickname": "Ann",
60         "email": "anna.johnson@example.com",
61         "workEmail": "a.johnson@brightmove.com",
62         "type": {
63           "id": 3,
64           "name": "Admin"
65         },
66         "companyGk": 555555,
67         "companyName": "BrightMove Inc.",
68         "companyGuid": "comp-1234-5678-9012-3456",
69         "createUserGk": 0,
70         "modifyUserGk": 0,
71         "username": "ajohnson",
72         "avatarUrl": "https://cdn.brightmove.com/avatars/ajohnson.png",
73         "timezoneId": 5,
74         "localeId": 1033,
75         "statusId": 1,
76         "displayFullName": "Anna B. Johnson",
77         "displayName": "Anna Johnson",
78         "displayNameLastFirst": "Johnson, Anna",
79         "bestEmail": "anna.johnson@example.com"
80       },
81       "modifyUser": {
82         "userGk": 222222,
83         "guid": "22222222-3333-4444-5555-666666666666",
84         "salutation": {
85           "id": 1,
86           "name": "Mr."
87         },
88         "firstName": "Robert",
89         "middleName": "C.",
90         "lastName": "Williams",
91         "nickname": "Rob",
92         "email": "robert.williams@example.com",
93         "workEmail": "r.williams@brightmove.com",
94         "type": {
95           "id": 2,
96           "name": "Employee"
97         },
98         "companyGk": 555555,
99         "companyName": "BrightMove Inc.",
100         "companyGuid": "comp-1234-5678-9012-3456",
101         "createUserGk": 111111,
102         "modifyUserGk": 111111,
103         "username": "rwilliams",
104         "avatarUrl": "https://cdn.brightmove.com/avatars/rwilliams.png",
105         "timezoneId": 5,
106         "localeId": 1033,
107         "statusId": 1,
108         "displayFullName": "Robert C. Williams",
109         "displayName": "Robert Williams",
110         "displayNameLastFirst": "Williams, Robert",
111         "bestEmail": "robert.williams@example.com"
112       },
113       "createDate": "2023-11-01T08:00:00Z",
114       "modifyDate": "2024-04-20T16:45:00Z",
115       "themeGk": 10,
116       "lookDate": "2024-05-01T00:00:00Z",
117       "unsubscribeDate": null,
118       "delegates": [],
119       "emailSignature": "Best regards,\nJames Smith",
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": "Project"
129     },
130     "memberCount": 12
131   },
132   {
133     "folderGk": 987654322,
134     "folderName": "Marketing Campaigns",
135     "shared": false,
136     "owned": true,
137     "createDate": "2024-01-15T13:30:00Z",
138     "owner": {
139       "userGk": 987654321,
140       "guid": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
141       "salutation": {
142         "id": 2,
143         "name": "Ms."
144       },
145       "firstName": "Emily",
146       "middleName": "R.",
147       "lastName": "Davis",
148       "nickname": "Em",
149       "email": "emily.davis@example.com",
150       "workEmail": "e.davis@brightmove.com",
151       "type": {
152         "id": 2,
153         "name": "Employee"
154       },
155       "companyGk": 555555,
156       "companyName": "BrightMove Inc.",
157       "companyGuid": "comp-1234-5678-9012-3456",
158       "createUserGk": 111111,
159       "modifyUserGk": 222222,
160       "username": "edavis",
161       "avatarUrl": "https://cdn.brightmove.com/avatars/edavis.png",
162       "timezoneId": 5,
163       "localeId": 1033,
164       "statusId": 1,
165       "phones": [
166         {
167           "id": 1002,
168           "phoneNumber": "+1-555-987-6543",
169           "type": {
170             "id": 2,
171             "name": "Work",
172             "sortOrder": 2,
173             "choice": false
174           },
175           "userGk": 987654321
176         }
177       ],
178       "primary": true,
179       "createUser": {
180         "userGk": 111111,
181         "guid": "11111111-2222-3333-4444-555555555555",
182         "salutation": {
183           "id": 2,
184           "name": "Ms."
185         },
186         "firstName": "Anna",
187         "middleName": "B.",
188         "lastName": "Johnson",
189         "nickname": "Ann",
190         "email": "anna.johnson@example.com",
191         "workEmail": "a.johnson@brightmove.com",
192         "type": {
193           "id": 3,
194           "name": "Admin"
195         },
196         "companyGk": 555555,
197         "companyName": "BrightMove Inc.",
198         "companyGuid": "comp-1234-5678-9012-3456",
199         "createUserGk": 0,
200         "modifyUserGk": 0,
201         "username": "ajohnson",
202         "avatarUrl": "https://cdn.brightmove.com/avatars/ajohnson.png",
203         "timezoneId": 5,
204         "localeId": 1033,
205         "statusId": 1,
206         "displayFullName": "Anna B. Johnson",
207         "displayName": "Anna Johnson",
208         "displayNameLastFirst": "Johnson, Anna",
209         "bestEmail": "anna.johnson@example.com"
210       },
211       "modifyUser": {
212         "userGk": 222222,
213         "guid": "22222222-3333-4444-5555-666666666666",
214         "salutation": {
215           "id": 1,
216           "name": "Mr."
217         },
218         "firstName": "Robert",
219         "middleName": "C.",
220         "lastName": "Williams",
221         "nickname": "Rob",
222         "email": "robert.williams@example.com",
223         "workEmail": "r.williams@brightmove.com",
224         "type": {
225           "id": 2,
226           "name": "Employee"
227         },
228         "companyGk": 555555,
229         "companyName": "BrightMove Inc.",
230         "companyGuid": "comp-1234-5678-9012-3456",
231         "createUserGk": 111111,
232         "modifyUserGk": 111111,
233         "username": "rwilliams",
234         "avatarUrl": "https://cdn.brightmove.com/avatars/rwilliams.png",
235         "timezoneId": 5,
236         "localeId": 1033,
237         "statusId": 1,
238         "displayFullName": "Robert C. Williams",
239         "displayName": "Robert Williams",
240         "displayNameLastFirst": "Williams, Robert",
241         "bestEmail": "robert.williams@example.com"
242       },
243       "createDate": "2023-12-01T10:00:00Z",
244       "modifyDate": "2024-04-15T14:20:00Z",
245       "themeGk": 12,
246       "lookDate": "2024-05-01T00:00:00Z",
247       "unsubscribeDate": null,
248       "delegates": [],
249       "emailSignature": "Cheers,\nEmily Davis",
250       "name": "Emily Davis",
251       "displayFullName": "Emily R. Davis",
252       "displayName": "Emily Davis",
253       "displayNameLastFirst": "Davis, Emily",
254       "bestEmail": "emily.davis@example.com"
255     },
256     "entityType": {
257       "id": 1,
258       "name": "Project"
259     },
260     "memberCount": 8
261   }
262 ]

Get a List of My Folders by Entity Type

Path parameters

entityTypeintegerRequired

List My Folders By Type

Path parameters

Headers

Response