Get a Folder by Type

GET

Path parameters

entityTypeintegerRequired

folderGklongRequired

Headers

X-Brightmove-User-ApiKeystringRequired

Response

folderGklongOptional

folderNamestringOptional

sharedbooleanOptional

ownedbooleanOptional

createDatedatetimeOptional

ownerobjectOptional

entityTypeobjectOptional

memberCountlongOptional

GET

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

200Retrieved

1 {
2   "folderGk": 1000000,
3   "folderName": "folderName",
4   "shared": true,
5   "owned": true,
6   "createDate": "2024-01-15T09:30:00Z",
7   "owner": {
8     "userGk": 1000000,
9     "guid": "guid",
10     "salutation": {
11       "id": 1000000,
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": 1,
22       "name": "name"
23     },
24     "companyGk": 1000000,
25     "companyName": "companyName",
26     "companyGuid": "companyGuid",
27     "createUserGk": 1000000,
28     "modifyUserGk": 1000000,
29     "username": "username",
30     "avatarUrl": "avatarUrl",
31     "timezoneId": 1,
32     "localeId": 1,
33     "statusId": 1,
34     "phones": [
35       {}
36     ],
37     "primary": true,
38     "createUser": {
39       "userGk": 1000000,
40       "guid": "guid",
41       "salutation": {
42         "id": 1000000
43       },
44       "firstName": "firstName",
45       "middleName": "middleName",
46       "lastName": "lastName",
47       "nickname": "nickname",
48       "email": "email",
49       "workEmail": "workEmail",
50       "companyGk": 1000000,
51       "companyName": "companyName",
52       "companyGuid": "companyGuid",
53       "createUserGk": 1000000,
54       "modifyUserGk": 1000000,
55       "username": "username",
56       "avatarUrl": "avatarUrl",
57       "timezoneId": 1,
58       "localeId": 1,
59       "statusId": 1,
60       "displayFullName": "displayFullName",
61       "displayNameLastFirst": "displayNameLastFirst",
62       "bestEmail": "bestEmail",
63       "displayName": "displayName"
64     },
65     "modifyUser": {
66       "userGk": 1000000,
67       "guid": "guid",
68       "salutation": {
69         "id": 1000000
70       },
71       "firstName": "firstName",
72       "middleName": "middleName",
73       "lastName": "lastName",
74       "nickname": "nickname",
75       "email": "email",
76       "workEmail": "workEmail",
77       "companyGk": 1000000,
78       "companyName": "companyName",
79       "companyGuid": "companyGuid",
80       "createUserGk": 1000000,
81       "modifyUserGk": 1000000,
82       "username": "username",
83       "avatarUrl": "avatarUrl",
84       "timezoneId": 1,
85       "localeId": 1,
86       "statusId": 1,
87       "displayFullName": "displayFullName",
88       "displayNameLastFirst": "displayNameLastFirst",
89       "bestEmail": "bestEmail",
90       "displayName": "displayName"
91     },
92     "createDate": "2024-01-15T09:30:00Z",
93     "modifyDate": "2024-01-15T09:30:00Z",
94     "themeGk": 1000000,
95     "lookDate": "2024-01-15T09:30:00Z",
96     "unsubscribeDate": "2024-01-15T09:30:00Z",
97     "delegates": [
98       {}
99     ],
100     "emailSignature": "emailSignature",
101     "name": "name",
102     "displayFullName": "displayFullName",
103     "displayNameLastFirst": "displayNameLastFirst",
104     "bestEmail": "bestEmail",
105     "displayName": "displayName"
106   },
107   "entityType": {
108     "id": 1000000,
109     "name": "name"
110   },
111   "memberCount": 1000000
112 }

Entity Type

Up Next

Built with

1	{
2	"folderGk": 1000000,
3	"folderName": "folderName",
4	"shared": true,
5	"owned": true,
6	"createDate": "2024-01-15T09:30:00Z",
7	"owner": {
8	"userGk": 1000000,
9	"guid": "guid",
10	"salutation": {
11	"id": 1000000,
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": 1,
22	"name": "name"
23	},
24	"companyGk": 1000000,
25	"companyName": "companyName",
26	"companyGuid": "companyGuid",
27	"createUserGk": 1000000,
28	"modifyUserGk": 1000000,
29	"username": "username",
30	"avatarUrl": "avatarUrl",
31	"timezoneId": 1,
32	"localeId": 1,
33	"statusId": 1,
34	"phones": [
35	{}
36	],
37	"primary": true,
38	"createUser": {
39	"userGk": 1000000,
40	"guid": "guid",
41	"salutation": {
42	"id": 1000000
43	},
44	"firstName": "firstName",
45	"middleName": "middleName",
46	"lastName": "lastName",
47	"nickname": "nickname",
48	"email": "email",
49	"workEmail": "workEmail",
50	"companyGk": 1000000,
51	"companyName": "companyName",
52	"companyGuid": "companyGuid",
53	"createUserGk": 1000000,
54	"modifyUserGk": 1000000,
55	"username": "username",
56	"avatarUrl": "avatarUrl",
57	"timezoneId": 1,
58	"localeId": 1,
59	"statusId": 1,
60	"displayFullName": "displayFullName",
61	"displayNameLastFirst": "displayNameLastFirst",
62	"bestEmail": "bestEmail",
63	"displayName": "displayName"
64	},
65	"modifyUser": {
66	"userGk": 1000000,
67	"guid": "guid",
68	"salutation": {
69	"id": 1000000
70	},
71	"firstName": "firstName",
72	"middleName": "middleName",
73	"lastName": "lastName",
74	"nickname": "nickname",
75	"email": "email",
76	"workEmail": "workEmail",
77	"companyGk": 1000000,
78	"companyName": "companyName",
79	"companyGuid": "companyGuid",
80	"createUserGk": 1000000,
81	"modifyUserGk": 1000000,
82	"username": "username",
83	"avatarUrl": "avatarUrl",
84	"timezoneId": 1,
85	"localeId": 1,
86	"statusId": 1,
87	"displayFullName": "displayFullName",
88	"displayNameLastFirst": "displayNameLastFirst",
89	"bestEmail": "bestEmail",
90	"displayName": "displayName"
91	},
92	"createDate": "2024-01-15T09:30:00Z",
93	"modifyDate": "2024-01-15T09:30:00Z",
94	"themeGk": 1000000,
95	"lookDate": "2024-01-15T09:30:00Z",
96	"unsubscribeDate": "2024-01-15T09:30:00Z",
97	"delegates": [
98	{}
99	],
100	"emailSignature": "emailSignature",
101	"name": "name",
102	"displayFullName": "displayFullName",
103	"displayNameLastFirst": "displayNameLastFirst",
104	"bestEmail": "bestEmail",
105	"displayName": "displayName"
106	},
107	"entityType": {
108	"id": 1000000,
109	"name": "name"
110	},
111	"memberCount": 1000000
112	}