Get all collections

GET

/collections

GET

/collections

curl -G https://api.postman.com/collections \
     -H "x-api-key: <apiKey>" \
     -d limit=3 \
     --data-urlencode "name=Test Collection" \
     -d offset=0 \
     -d workspace=1f0df51a-8658-4ee8-a2a1-d2567dfa09a9

{
  "collections": [
    {
      "id": "dac5eac9-148d-a32e-b76b-3edee9da28f7",
      "name": "Cloud API",
      "owner": "12345678",
      "createdAt": "2022-04-12T10:29:46.000Z",
      "updatedAt": "2022-04-12T10:29:56.000Z",
      "uid": "12345678-dac5eac9-148d-a32e-b76b-3edee9da28f7",
      "isPublic": true
    },
    {
      "id": "12ece9e1-2abf-4edc-8e34-de66e74114d2",
      "name": "Test Collection",
      "owner": "12345678",
      "createdAt": "2022-01-13T10:21:46.000Z",
      "updatedAt": "2022-02-12T11:29:56.000Z",
      "uid": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2",
      "fork": {
        "label": "Test Fork",
        "createdAt": "2022-06-16T19:51:44.069Z",
        "from": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"
      },
      "isPublic": false
    },
    {
      "id": "f695cab7-6878-eb55-7943-ad88e1ccfd65",
      "name": "Postman Echo",
      "owner": "12345678",
      "createdAt": "2021-04-11T09:18:26.000Z",
      "updatedAt": "2022-05-01T15:29:32.000Z",
      "uid": "12345678-f695cab7-6878-eb55-7943-ad88e1ccfd65",
      "isPublic": true
    }
  ],
  "meta": {
    "total": 30,
    "offset": 0,
    "limit": 3
  }
}

Gets all of your collections. The response includes all of your subscribed collections.

Note:

It’s recommended that you use pagination with this endpoint. Pagination improves endpoint performance. Unpaginated calls are considered deprecated and are subject to change.
Filtering with the name parameter when you also pass the limit and offset parameters is not supported.
If you pass an invalid workspace ID for the workspace query parameter, this endpoint returns an HTTP 200 OK response with an empty array.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

workspacestringOptional

The workspace's ID.

namestringOptional

Filter results by collections whose name exactly matches the given value. Partial or substring matches are not supported.

limitintegerOptional

The maximum number of rows to return in the response.

offsetintegerOptional

The zero-based offset of the first item to return.

Response

Successful Response

collectionslist of objectsOptional

A list of collections.

metaobjectOptional

The response's meta information for paginated results.

Errors

401

Unauthorized Error

429

Too Many Requests Error

500

Internal Server Error