Get collection access keys

GET

/collection-access-keys

GET

/collection-access-keys

$ curl https://api.getpostman.com/collection-access-keys \
>      -H "x-api-key: <apiKey>"

1 {
2   "data": [
3     {
4       "id": "Njg5OjU3MDQ1NjYtYmQxZDU3NzktMWVkNS00ZDhjLWI0ZmQtZWRhOGY2Mzg1NTY0",
5       "token": "PMAT-**********************43BR",
6       "status": "ACTIVE",
7       "teamId": 123,
8       "userId": 12345678,
9       "collectionId": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2",
10       "expiresAfter": "2024-06-11T13:21:11.000Z",
11       "lastUsedAt": "",
12       "createdAt": "2024-04-12T13:21:11.000Z",
13       "updatedAt": "2024-04-09T11:00:53.000Z"
14     },
15     {
16       "id": "K7yJPzQ18BC7Snm09PXL12RMmnq57hQorFJW8JnCKhQ11JmNQiTlgXnQ1p93jGYN",
17       "token": "PMAT-**********************51FZ",
18       "status": "ACTIVE",
19       "teamId": 123,
20       "userId": 56781234,
21       "collectionId": "56781234-68e5e7ac-c134-45f4-9770-40e72f3fc474",
22       "expiresAfter": "2024-06-11T13:21:11.000Z",
23       "lastUsedAt": "2024-04-29T08:24:23.000Z",
24       "createdAt": "2024-04-22T10:11:00.000Z",
25       "updatedAt": "2024-04-22T10:11:00.000Z"
26     }
27   ],
28   "meta": {
29     "nextCursor": "b2Zmc2V0PTEwJmxpbWl0PTEw",
30     "prevCursor": ""
31   }
32 }

Gets the authenticated user’s personal and team collection access keys.

Note:

The expiresAfter property in the response represents the date and time at which the access key expires. Collection access keys are valid for 60 days. If unused, the access key expires after 60 days. If someone uses the access key, then its expiration date increases by another 60 days.
If the collection key is unused, the lastUsedAt property in the response returns an empty string.

Gets the authenticated user's personal and team [collection access keys](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-collection-access-key). **Note:** - The `expiresAfter` property in the response represents the date and time at which the access key expires. Collection access keys are valid for 60 days. If unused, the access key expires after 60 days. If someone uses the access key, then its expiration date increases by another 60 days. - If the collection key is unused, the `lastUsedAt` property in the response returns an empty string.

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)>.

Query parameters

collectionIdstringOptionalformat: "uid"

Filter the results by a collection's unique ID.

cursorstringOptional

The pointer to the first record of the set of paginated results. To view the next response, use the nextCursor value for this parameter.

Response

Successful Response

datalist of objects

A list of collection access keys.

metaobject

The response’s non-standard metadata information.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error