Get a list of folder members

get/folders/{folderId}/members

Internal-Use Only

Returns a list of folder members. Standard paging, filtering, and sorting options are available. The media type of the returned collection items is application/vnd.sas.content.folder.member. Default sorting for this collection is name:ascending, unless the folder is of the history folder type. Default sorting for history folders is added:descending, which orders the elements starting with the most recently added.

Request Samples

Response Samples

200
application/json
1{
2  "version": 2,
3  "accept": "application/json",
4  "count": 3,
5  "start": 0,
6  "limit": 20,
7  "name": "members",
8  "items": [
9    {
10      "creationTimeStamp": "2022-06-20T18:19:13.92Z",
11      "createdBy": "stpweb1",
12      "modifiedTimeStamp": "2022-06-20T18:19:13.92Z",
13      "modifiedBy": "stpweb1",
14      "version": 2,
15      "id": "a73fd398-8969-415a-b0e2-3b423cf95849",
16      "name": "Folders_Spike.png",
17      "added": "2022-06-20T18:19:13.947099Z",
18      "parentFolderUri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
19      "uri": "/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab",
20      "type": "child",
21      "contentType": "file",
22      "typeDefName": "file_png",
23      "links": [
24        {
25          "method": "GET",
26          "rel": "self",
27          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
28          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
29          "type": "application/vnd.sas.content.folder.member"
30        },
31        {
32          "method": "GET",
33          "rel": "up",
34          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
35          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
36          "type": "application/vnd.sas.content.folder"
37        },
38        {
39          "method": "GET",
40          "rel": "getResource",
41          "href": "/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab",
42          "uri": "/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab",
43          "type": "application/vnd.sas.summary"
44        },
45        {
46          "method": "PUT",
47          "rel": "putResource",
48          "href": "/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab",
49          "uri": "/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab"
50        },
51        {
52          "method": "DELETE",
53          "rel": "deleteResource",
54          "href": "/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab",
55          "uri": "/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab"
56        },
57        {
58          "method": "GET",
59          "rel": "ancestors",
60          "href": "/folders/ancestors?childUri=/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab",
61          "uri": "/folders/ancestors?childUri=/files/files/016cf2b0-ef36-4344-9896-0439a027d8ab",
62          "type": "application/vnd.sas.content.folder.ancestor"
63        },
64        {
65          "method": "PUT",
66          "rel": "update",
67          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
68          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
69          "type": "application/vnd.sas.content.folder.member"
70        },
71        {
72          "method": "DELETE",
73          "rel": "delete",
74          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
75          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849"
76        },
77        {
78          "method": "PUT",
79          "rel": "validateRename",
80          "href": "/folders/commons/validations/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849/name?value={newname}&type={newtype}",
81          "uri": "/folders/commons/validations/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849/name?value={newname}&type={newtype}",
82          "type": "application/vnd.sas.validation"
83        },
84        {
85          "method": "GET",
86          "rel": "transferExport",
87          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
88          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
89          "type": "application/vnd.sas.transfer.object"
90        },
91        {
92          "method": "PUT",
93          "rel": "transferImportUpdate",
94          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
95          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/a73fd398-8969-415a-b0e2-3b423cf95849",
96          "type": "application/vnd.sas.transfer.object",
97          "responseType": "application/vnd.sas.summary"
98        },
99        {
100          "method": "POST",
101          "rel": "transferImport",
102          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members",
103          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members",
104          "type": "application/vnd.sas.transfer.object",
105          "responseType": "application/vnd.sas.summary"
106        }
107      ]
108    },
109    {
110      "creationTimeStamp": "2022-06-20T18:17:36.830648Z",
111      "createdBy": "stpweb1",
112      "modifiedTimeStamp": "2022-06-20T18:17:36.830649Z",
113      "modifiedBy": "stpweb1",
114      "version": 2,
115      "id": "4f0241d9-7953-4967-8afb-cbc5ddeb6c61",
116      "name": "New Folder",
117      "added": "2022-06-20T18:17:36.837359Z",
118      "parentFolderUri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
119      "uri": "/folders/folders/e78521ad-5442-4eef-a0e4-a27773b380db",
120      "type": "child",
121      "contentType": "folder",
122      "links": [
123        {
124          "method": "GET",
125          "rel": "self",
126          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/4f0241d9-7953-4967-8afb-cbc5ddeb6c61",
127          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/4f0241d9-7953-4967-8afb-cbc5ddeb6c61",
128          "type": "application/vnd.sas.content.folder.member"
129        },
130        {
131          "method": "GET",
132          "rel": "up",
133          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
134          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
135          "type": "application/vnd.sas.content.folder"
136        },
137        {
138          "method": "GET",
139          "rel": "getResource",
140          "href": "/folders/folders/e78521ad-5442-4eef-a0e4-a27773b380db",
141          "uri": "/folders/folders/e78521ad-5442-4eef-a0e4-a27773b380db",
142          "type": "application/vnd.sas.summary"
143        },
144        {
145          "method": "PUT",
146          "rel": "putResource",
147          "href": "/folders/folders/e78521ad-5442-4eef-a0e4-a27773b380db",
148          "uri": "/folders/folders/e78521ad-5442-4eef-a0e4-a27773b380db"
149        },
150        {
151          "method": "DELETE",
152          "rel": "deleteResource",
153          "href": "/folders/folders/e78521ad-5442-4eef-a0e4-a27773b380db",
154          "uri": "/folders/folders/e78521ad-5442-4eef-a0e4-a27773b380db"
155        },
156        {
157          "method": "GET",
158          "rel": "ancestors",
159          "href": "/folders/ancestors?childUri=/folders/folders/e78521ad-5442-4eef-a0e4-a27773b380db",
160          "uri": "/folders/ancestors?childUri=/folders/folders/e78521ad-5442-4eef-a0e4-a27773b380db",
161          "type": "application/vnd.sas.content.folder.ancestor"
162        },
163        {
164          "method": "PUT",
165          "rel": "update",
166          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/4f0241d9-7953-4967-8afb-cbc5ddeb6c61",
167          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/4f0241d9-7953-4967-8afb-cbc5ddeb6c61",
168          "type": "application/vnd.sas.content.folder.member"
169        },
170        {
171          "method": "DELETE",
172          "rel": "delete",
173          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/4f0241d9-7953-4967-8afb-cbc5ddeb6c61",
174          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/4f0241d9-7953-4967-8afb-cbc5ddeb6c61"
175        },
176        {
177          "method": "PUT",
178          "rel": "validateRename",
179          "href": "/folders/commons/validations/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/4f0241d9-7953-4967-8afb-cbc5ddeb6c61/name?value={newname}&type={newtype}",
180          "uri": "/folders/commons/validations/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/4f0241d9-7953-4967-8afb-cbc5ddeb6c61/name?value={newname}&type={newtype}",
181          "type": "application/vnd.sas.validation"
182        },
183        {
184          "method": "GET",
185          "rel": "transferExport",
186          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/4f0241d9-7953-4967-8afb-cbc5ddeb6c61",
187          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/4f0241d9-7953-4967-8afb-cbc5ddeb6c61",
188          "type": "application/vnd.sas.transfer.object"
189        },
190        {
191          "method": "PUT",
192          "rel": "transferImportUpdate",
193          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/4f0241d9-7953-4967-8afb-cbc5ddeb6c61",
194          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/4f0241d9-7953-4967-8afb-cbc5ddeb6c61",
195          "type": "application/vnd.sas.transfer.object",
196          "responseType": "application/vnd.sas.summary"
197        },
198        {
199          "method": "POST",
200          "rel": "transferImport",
201          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members",
202          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members",
203          "type": "application/vnd.sas.transfer.object",
204          "responseType": "application/vnd.sas.summary"
205        },
206        {
207          "method": "POST",
208          "rel": "addMember",
209          "href": "/folders/folders/e78521ad-5442-4eef-a0e4-a27773b380db/members",
210          "uri": "/folders/folders/e78521ad-5442-4eef-a0e4-a27773b380db/members",
211          "type": "application/vnd.sas.content.folder.member"
212        },
213        {
214          "method": "PUT",
215          "rel": "validateNewMemberName",
216          "href": "/folders/commons/validations/folders/e78521ad-5442-4eef-a0e4-a27773b380db/members/@new/name?value={newname}&type=folder",
217          "uri": "/folders/commons/validations/folders/e78521ad-5442-4eef-a0e4-a27773b380db/members/@new/name?value={newname}&type=folder",
218          "type": "application/vnd.sas.validation"
219        },
220        {
221          "method": "POST",
222          "rel": "createChild",
223          "href": "/folders/folders?parentFolderUri=/folders/folders/e78521ad-5442-4eef-a0e4-a27773b380db",
224          "uri": "/folders/folders?parentFolderUri=/folders/folders/e78521ad-5442-4eef-a0e4-a27773b380db",
225          "type": "application/vnd.sas.content.folder"
226        }
227      ]
228    },
229    {
230      "creationTimeStamp": "2022-06-20T18:17:19.550286Z",
231      "createdBy": "stpweb1",
232      "modifiedTimeStamp": "2022-06-20T18:17:19.550288Z",
233      "modifiedBy": "stpweb1",
234      "version": 2,
235      "id": "9586f4b2-24b9-4517-8249-2206d7b50306",
236      "name": "SAS Videos",
237      "added": "2022-06-20T18:17:19.566851Z",
238      "parentFolderUri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
239      "uri": "/folders/folders/9a0bbb95-d7f0-43ac-b90f-a6c5fd546f1e",
240      "type": "child",
241      "contentType": "folder",
242      "links": [
243        {
244          "method": "GET",
245          "rel": "self",
246          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/9586f4b2-24b9-4517-8249-2206d7b50306",
247          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/9586f4b2-24b9-4517-8249-2206d7b50306",
248          "type": "application/vnd.sas.content.folder.member"
249        },
250        {
251          "method": "GET",
252          "rel": "up",
253          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
254          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172",
255          "type": "application/vnd.sas.content.folder"
256        },
257        {
258          "method": "GET",
259          "rel": "getResource",
260          "href": "/folders/folders/9a0bbb95-d7f0-43ac-b90f-a6c5fd546f1e",
261          "uri": "/folders/folders/9a0bbb95-d7f0-43ac-b90f-a6c5fd546f1e",
262          "type": "application/vnd.sas.summary"
263        },
264        {
265          "method": "PUT",
266          "rel": "putResource",
267          "href": "/folders/folders/9a0bbb95-d7f0-43ac-b90f-a6c5fd546f1e",
268          "uri": "/folders/folders/9a0bbb95-d7f0-43ac-b90f-a6c5fd546f1e"
269        },
270        {
271          "method": "DELETE",
272          "rel": "deleteResource",
273          "href": "/folders/folders/9a0bbb95-d7f0-43ac-b90f-a6c5fd546f1e",
274          "uri": "/folders/folders/9a0bbb95-d7f0-43ac-b90f-a6c5fd546f1e"
275        },
276        {
277          "method": "GET",
278          "rel": "ancestors",
279          "href": "/folders/ancestors?childUri=/folders/folders/9a0bbb95-d7f0-43ac-b90f-a6c5fd546f1e",
280          "uri": "/folders/ancestors?childUri=/folders/folders/9a0bbb95-d7f0-43ac-b90f-a6c5fd546f1e",
281          "type": "application/vnd.sas.content.folder.ancestor"
282        },
283        {
284          "method": "PUT",
285          "rel": "update",
286          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/9586f4b2-24b9-4517-8249-2206d7b50306",
287          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/9586f4b2-24b9-4517-8249-2206d7b50306",
288          "type": "application/vnd.sas.content.folder.member"
289        },
290        {
291          "method": "DELETE",
292          "rel": "delete",
293          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/9586f4b2-24b9-4517-8249-2206d7b50306",
294          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/9586f4b2-24b9-4517-8249-2206d7b50306"
295        },
296        {
297          "method": "PUT",
298          "rel": "validateRename",
299          "href": "/folders/commons/validations/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/9586f4b2-24b9-4517-8249-2206d7b50306/name?value={newname}&type={newtype}",
300          "uri": "/folders/commons/validations/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/9586f4b2-24b9-4517-8249-2206d7b50306/name?value={newname}&type={newtype}",
301          "type": "application/vnd.sas.validation"
302        },
303        {
304          "method": "GET",
305          "rel": "transferExport",
306          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/9586f4b2-24b9-4517-8249-2206d7b50306",
307          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/9586f4b2-24b9-4517-8249-2206d7b50306",
308          "type": "application/vnd.sas.transfer.object"
309        },
310        {
311          "method": "PUT",
312          "rel": "transferImportUpdate",
313          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/9586f4b2-24b9-4517-8249-2206d7b50306",
314          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members/9586f4b2-24b9-4517-8249-2206d7b50306",
315          "type": "application/vnd.sas.transfer.object",
316          "responseType": "application/vnd.sas.summary"
317        },
318        {
319          "method": "POST",
320          "rel": "transferImport",
321          "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members",
322          "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members",
323          "type": "application/vnd.sas.transfer.object",
324          "responseType": "application/vnd.sas.summary"
325        },
326        {
327          "method": "POST",
328          "rel": "addMember",
329          "href": "/folders/folders/9a0bbb95-d7f0-43ac-b90f-a6c5fd546f1e/members",
330          "uri": "/folders/folders/9a0bbb95-d7f0-43ac-b90f-a6c5fd546f1e/members",
331          "type": "application/vnd.sas.content.folder.member"
332        },
333        {
334          "method": "PUT",
335          "rel": "validateNewMemberName",
336          "href": "/folders/commons/validations/folders/9a0bbb95-d7f0-43ac-b90f-a6c5fd546f1e/members/@new/name?value={newname}&type=folder",
337          "uri": "/folders/commons/validations/folders/9a0bbb95-d7f0-43ac-b90f-a6c5fd546f1e/members/@new/name?value={newname}&type=folder",
338          "type": "application/vnd.sas.validation"
339        },
340        {
341          "method": "POST",
342          "rel": "createChild",
343          "href": "/folders/folders?parentFolderUri=/folders/folders/9a0bbb95-d7f0-43ac-b90f-a6c5fd546f1e",
344          "uri": "/folders/folders?parentFolderUri=/folders/folders/9a0bbb95-d7f0-43ac-b90f-a6c5fd546f1e",
345          "type": "application/vnd.sas.content.folder"
346        }
347      ]
348    }
349  ],
350  "links": [
351    {
352      "method": "GET",
353      "rel": "self",
354      "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members?start=0&limit=20",
355      "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members?start=0&limit=20",
356      "type": "application/vnd.sas.collection",
357      "itemType": "application/vnd.sas.content.folder"
358    },
359    {
360      "method": "POST",
361      "rel": "createMember",
362      "href": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members",
363      "uri": "/folders/folders/f4300a6d-407e-46fc-9c8a-e8142bd5d172/members",
364      "type": "application/vnd.sas.content.folder.member",
365      "responseType": "application/vnd.sas.content.folder.member"
366    }
367  ]
368}

Path Parameters

Name	Type	Required	Description
folderId	string<object-id>	true	The identifier of a specific folder, or of one of the delegate strings @myFolder, @appDataFolder, @myHistory, @myFavorites, or @public.

Query Parameters

Name	Type	Required	Description
filter	string	false	Filter criteria for returned members. See Filtering in REST APIs. For example, you can filter for a member with a given name as a way to test if a folder already has a member with that name: ?filter=eq(name, 'bobsyouruncle')
followReferences	boolean	false	If true, references to other folders are followed when returning the recursive list of members. If recursive is false, then the value of this parameter is meaningless. The default value of this parameter is false.
limit	integer<int64>	false	Maximum number of members to return. The default value is 20.
recursive	boolean	false	If true, the members of the requested folder, plus all of its descendants, are returned in a flat list (no order is guaranteed). Reference members that refer to folders are not followed unless the followReferences parameter is true. The default value of this parameter is false.
sortBy	string	false	Sort returned collection of members. See Sorting in REST APIs. The member collection can be sorted by folders first by using sortBy=eq(contentType,'folder'):descending Use :ascending to soft by folders last. Specifying sortBy=eq(contentType,'folder'):descending,name:ascending,type:ascending sorts by folders first, then by name, then by type.
start	integer<int64>	false	Offset of first member to return. The default value is 0.

Header Parameters

Name	Type	Required	Description
Accept-Item	string	false	If provided, this should be an alternative media type that the service recognizes. If the media type is not one that the service can provide, a 406 response is returned. Valid media types for the member collection are application/vnd.sas.content.folder.member+json (default), application/vnd.sas.content.folder.member.summary+json (an abbreviated format that provides fewer links, but better performance), and application/vnd.sas.summary+json (a standard summary representation).
Accept-Language	string	false	Enumerates the languages that the client prefers to use for the response. This can be used to provide localized data where available.

Responses

Status	Meaning	Description
200	OK	The request succeeded. A list of folder members was returned.	Headers	Schema
400	Bad Request	The request was invalid. An invalid filter or combination of request parameters was provided.		Schema
404	Not Found	No folder exists at the requested path.		Schema