List All Folders By Type

GET

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

GET

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

1 curl https://app.brightmove.com/ATS/app/folder/list/all/0

Try it

200Retrieved

1 [
2   {
3     "folderGk": 0,
4     "folderName": "folderName",
5     "shared": false,
6     "owned": false,
7     "createDate": "createDate",
8     "owner": {
9       "userGk": 0,
10       "guid": "guid",
11       "salutation": {
12         "id": 0,
13         "name": "name"
14       },
15       "firstName": "firstName",
16       "middleName": "middleName",
17       "lastName": "lastName",
18       "nickname": "nickname",
19       "email": "email",
20       "workEmail": "workEmail",
21       "type": {
22         "id": 0,
23         "name": "name"
24       },
25       "companyGk": 0,
26       "companyName": "companyName",
27       "companyGuid": "companyGuid",
28       "createUserGk": 0,
29       "modifyUserGk": 0,
30       "username": "username",
31       "avatarUrl": "avatarUrl",
32       "timezoneId": 0,
33       "localeId": 0,
34       "statusId": 0,
35       "phones": [
36         {
37           "id": 0,
38           "phoneNumber": "phoneNumber",
39           "type": {
40             "id": 0,
41             "name": "name",
42             "sortOrder": 0,
43             "choice": false
44           },
45           "userGk": 0
46         }
47       ],
48       "primary": false,
49       "createUser": {
50         "userGk": 0,
51         "guid": "guid",
52         "salutation": {
53           "id": 0,
54           "name": "name"
55         },
56         "firstName": "firstName",
57         "middleName": "middleName",
58         "lastName": "lastName",
59         "nickname": "nickname",
60         "email": "email",
61         "workEmail": "workEmail",
62         "type": {
63           "id": 0,
64           "name": "name"
65         },
66         "companyGk": 0,
67         "companyName": "companyName",
68         "companyGuid": "companyGuid",
69         "createUserGk": 0,
70         "modifyUserGk": 0,
71         "username": "username",
72         "avatarUrl": "avatarUrl",
73         "timezoneId": 0,
74         "localeId": 0,
75         "statusId": 0,
76         "displayNameLastFirst": "displayNameLastFirst",
77         "displayFullName": "displayFullName",
78         "displayName": "displayName",
79         "bestEmail": "bestEmail"
80       },
81       "modifyUser": {
82         "userGk": 0,
83         "guid": "guid",
84         "salutation": {
85           "id": 0,
86           "name": "name"
87         },
88         "firstName": "firstName",
89         "middleName": "middleName",
90         "lastName": "lastName",
91         "nickname": "nickname",
92         "email": "email",
93         "workEmail": "workEmail",
94         "type": {
95           "id": 0,
96           "name": "name"
97         },
98         "companyGk": 0,
99         "companyName": "companyName",
100         "companyGuid": "companyGuid",
101         "createUserGk": 0,
102         "modifyUserGk": 0,
103         "username": "username",
104         "avatarUrl": "avatarUrl",
105         "timezoneId": 0,
106         "localeId": 0,
107         "statusId": 0,
108         "displayNameLastFirst": "displayNameLastFirst",
109         "displayFullName": "displayFullName",
110         "displayName": "displayName",
111         "bestEmail": "bestEmail"
112       },
113       "createDate": "createDate",
114       "modifyDate": "modifyDate",
115       "themeGk": 0,
116       "lookDate": "lookDate",
117       "unsubscribeDate": "unsubscribeDate",
118       "delegates": [
119         {
120           "userGk": 0,
121           "guid": "guid",
122           "salutation": {
123             "id": 0,
124             "name": "name"
125           },
126           "firstName": "firstName",
127           "middleName": "middleName",
128           "lastName": "lastName",
129           "nickname": "nickname",
130           "email": "email",
131           "workEmail": "workEmail",
132           "type": {
133             "id": 0,
134             "name": "name"
135           },
136           "companyGk": 0,
137           "companyName": "companyName",
138           "companyGuid": "companyGuid",
139           "createUserGk": 0,
140           "modifyUserGk": 0,
141           "username": "username",
142           "avatarUrl": "avatarUrl",
143           "timezoneId": 0,
144           "localeId": 0,
145           "statusId": 0,
146           "phones": [
147             {
148               "id": 0,
149               "phoneNumber": "phoneNumber",
150               "type": {
151                 "id": 0,
152                 "name": "name",
153                 "sortOrder": 0,
154                 "choice": false
155               },
156               "userGk": 0
157             }
158           ],
159           "primary": false,
160           "createUser": {
161             "userGk": 0,
162             "guid": "guid",
163             "salutation": {
164               "id": 0,
165               "name": "name"
166             },
167             "firstName": "firstName",
168             "middleName": "middleName",
169             "lastName": "lastName",
170             "nickname": "nickname",
171             "email": "email",
172             "workEmail": "workEmail",
173             "type": {
174               "id": 0,
175               "name": "name"
176             },
177             "companyGk": 0,
178             "companyName": "companyName",
179             "companyGuid": "companyGuid",
180             "createUserGk": 0,
181             "modifyUserGk": 0,
182             "username": "username",
183             "avatarUrl": "avatarUrl",
184             "timezoneId": 0,
185             "localeId": 0,
186             "statusId": 0,
187             "displayNameLastFirst": "displayNameLastFirst",
188             "displayFullName": "displayFullName",
189             "displayName": "displayName",
190             "bestEmail": "bestEmail"
191           },
192           "modifyUser": {
193             "userGk": 0,
194             "guid": "guid",
195             "salutation": {
196               "id": 0,
197               "name": "name"
198             },
199             "firstName": "firstName",
200             "middleName": "middleName",
201             "lastName": "lastName",
202             "nickname": "nickname",
203             "email": "email",
204             "workEmail": "workEmail",
205             "type": {
206               "id": 0,
207               "name": "name"
208             },
209             "companyGk": 0,
210             "companyName": "companyName",
211             "companyGuid": "companyGuid",
212             "createUserGk": 0,
213             "modifyUserGk": 0,
214             "username": "username",
215             "avatarUrl": "avatarUrl",
216             "timezoneId": 0,
217             "localeId": 0,
218             "statusId": 0,
219             "displayNameLastFirst": "displayNameLastFirst",
220             "displayFullName": "displayFullName",
221             "displayName": "displayName",
222             "bestEmail": "bestEmail"
223           },
224           "createDate": "createDate",
225           "modifyDate": "modifyDate",
226           "themeGk": 0,
227           "lookDate": "lookDate",
228           "unsubscribeDate": "unsubscribeDate",
229           "emailSignature": "emailSignature",
230           "startDate": "startDate",
231           "endDate": "endDate",
232           "name": "name",
233           "displayNameLastFirst": "displayNameLastFirst",
234           "displayFullName": "displayFullName",
235           "displayName": "displayName",
236           "bestEmail": "bestEmail"
237         }
238       ],
239       "emailSignature": "emailSignature",
240       "name": "name",
241       "displayNameLastFirst": "displayNameLastFirst",
242       "displayFullName": "displayFullName",
243       "displayName": "displayName",
244       "bestEmail": "bestEmail"
245     },
246     "entityType": {
247       "id": 0,
248       "name": "name"
249     },
250     "memberCount": 0
251   }
252 ]

Get a List of All Folders by Entity Type

Path parameters

entityTypeintegerRequired

Response

folderGklongOptional

folderNamestringOptional

sharedbooleanOptional

ownedbooleanOptional

createDatedatetimeOptional

ownerobjectOptional

entityTypeobjectOptional

memberCountlongOptional

List All Folders By Type

Path parameters

Headers

Response

Errors