Get a Folder by Type

GET

https://app.brightmove.com/ATS/app/folder/get/:entityType/:folderGk

GET

/ATS/app/folder/get/:entityType/:folderGk

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

Try it

200Retrieved

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

Get a Folder by Type

Path parameters

entityTypeintegerRequired

folderGklongRequired

Response

folderGklongOptional

folderNamestringOptional

sharedbooleanOptional

ownedbooleanOptional

createDatedatetimeOptional

ownerobjectOptional

entityTypeobjectOptional

memberCountlongOptional

Get a Folder by Type

Path parameters

Headers

Response

Errors