Get a folder

GET

/collections/:collectionId/folders/:folderId

GET

/collections/:collectionId/folders/:folderId

$ curl https://api.getpostman.com/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/folders/65a99e60-8e0a-4b6e-b79c-7d8264cc5caa \
>      -H "x-api-key: <apiKey>"

1 {
2   "model_id": "65a99e60-8e0a-4b6e-b79c-7d8264cc5caa",
3   "meta": {
4     "action": "find",
5     "changeset": false,
6     "model": "folder",
7     "populate": false
8   },
9   "data": {
10     "id": "65a99e60-8e0a-4b6e-b79c-7d8264cc5caa",
11     "name": "Test Folder",
12     "description": "This is a test collection folder.",
13     "createdAt": "2022-08-29T16:49:19.964Z",
14     "updatedAt": "2022-08-29T16:49:19.964Z",
15     "owner": "12345678",
16     "collection": "12ece9e1-2abf-4edc-8e34-de66e74114d2",
17     "auth": {
18       "apikey": [
19         {
20           "key": "value",
21           "value": "{{apiKey}}"
22         },
23         {
24           "key": "key",
25           "value": "X-Api-Key"
26         },
27         {
28           "key": "in",
29           "value": "header"
30         }
31       ],
32       "type": "apikey"
33     },
34     "events": null,
35     "folder": null,
36     "folders_order": [
37       "65a99e60-8e0a-4b6e-b79c-7d8264cc5caa",
38       "5c341de9-5751-461f-b7bd-af86bbae740c"
39     ],
40     "order": [
41       "81b49e05-0b87-4ca4-ac8c-091aaedafea3",
42       "929acf24-4234-45e1-59cf-dc2b27ea7603",
43       "3cfc2ac8-00a9-47d2-415d-049773f23268"
44     ],
45     "variables": null
46   }
47 }

Gets information about a folder in a collection.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

folderIdstringRequired

The folder's ID.

collectionIdstringRequired

The collection's ID.

Query parameters

idsbooleanOptional

If true, returns only properties that contain ID values in the response.

uidbooleanOptional

If true, returns all IDs in UID format (userId-id).

populatebooleanOptional

If true, returns all of the collection item's contents.

Response

Successful Response

model_idstring

The folder's ID.

metamap from strings to any

A Postman-specific response that contains information about the internal performed operation.

dataobject

Information about the folder. For a complete list of properties, refer to the Folders entry in the Postman Collection Format documentation.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error