Get Clients Available Folders

GET

Get List of Folders to which a Client is not assigned.

Path parameters

guidstringRequired

Headers

X-Brightmove-User-ApiKeystringRequired

X-Brightmove-Company-ApiKeystringOptional

Response

folderGklongOptional

folderNamestringOptional

sharedbooleanOptional

ownedbooleanOptional

createDatedatetimeOptional

ownerobjectOptional

entityTypeobjectOptional

memberCountlongOptional

GET

1 curl https://app.brightmove.com/ATS/app/client/folder/guid/available

200Retrieved

1 [
2   {
3     "folderGk": 1000000,
4     "folderName": "folderName",
5     "shared": true,
6     "owned": true,
7     "createDate": "2024-01-15T09:30:00Z",
8     "owner": {
9       "userGk": 1000000,
10       "guid": "guid",
11       "salutation": {
12         "id": 1000000
13       },
14       "firstName": "firstName",
15       "middleName": "middleName",
16       "lastName": "lastName",
17       "nickname": "nickname",
18       "email": "email",
19       "workEmail": "workEmail",
20       "companyGk": 1000000,
21       "companyName": "companyName",
22       "companyGuid": "companyGuid",
23       "createUserGk": 1000000,
24       "modifyUserGk": 1000000,
25       "username": "username",
26       "avatarUrl": "avatarUrl",
27       "timezoneId": 1,
28       "localeId": 1,
29       "statusId": 1,
30       "phones": [
31         {}
32       ],
33       "primary": true,
34       "createDate": "2024-01-15T09:30:00Z",
35       "modifyDate": "2024-01-15T09:30:00Z",
36       "themeGk": 1000000,
37       "lookDate": "2024-01-15T09:30:00Z",
38       "unsubscribeDate": "2024-01-15T09:30:00Z",
39       "delegates": [
40         {}
41       ],
42       "emailSignature": "emailSignature",
43       "name": "name",
44       "displayName": "displayName",
45       "displayNameLastFirst": "displayNameLastFirst",
46       "bestEmail": "bestEmail",
47       "displayFullName": "displayFullName"
48     },
49     "entityType": {
50       "id": 1000000,
51       "name": "name"
52     },
53     "memberCount": 1000000
54   }
55 ]

Unassign Client From Folder

Up Next

Built with

1	[
2	{
3	"folderGk": 1000000,
4	"folderName": "folderName",
5	"shared": true,
6	"owned": true,
7	"createDate": "2024-01-15T09:30:00Z",
8	"owner": {
9	"userGk": 1000000,
10	"guid": "guid",
11	"salutation": {
12	"id": 1000000
13	},
14	"firstName": "firstName",
15	"middleName": "middleName",
16	"lastName": "lastName",
17	"nickname": "nickname",
18	"email": "email",
19	"workEmail": "workEmail",
20	"companyGk": 1000000,
21	"companyName": "companyName",
22	"companyGuid": "companyGuid",
23	"createUserGk": 1000000,
24	"modifyUserGk": 1000000,
25	"username": "username",
26	"avatarUrl": "avatarUrl",
27	"timezoneId": 1,
28	"localeId": 1,
29	"statusId": 1,
30	"phones": [
31	{}
32	],
33	"primary": true,
34	"createDate": "2024-01-15T09:30:00Z",
35	"modifyDate": "2024-01-15T09:30:00Z",
36	"themeGk": 1000000,
37	"lookDate": "2024-01-15T09:30:00Z",
38	"unsubscribeDate": "2024-01-15T09:30:00Z",
39	"delegates": [
40	{}
41	],
42	"emailSignature": "emailSignature",
43	"name": "name",
44	"displayName": "displayName",
45	"displayNameLastFirst": "displayNameLastFirst",
46	"bestEmail": "bestEmail",
47	"displayFullName": "displayFullName"
48	},
49	"entityType": {
50	"id": 1000000,
51	"name": "name"
52	},
53	"memberCount": 1000000
54	}
55	]