Get a system environment's associations

GET

/api-catalog/system-environments/:systemEnvironmentId/associations

GET

/api-catalog/system-environments/:systemEnvironmentId/associations

$ curl https://api.getpostman.com/api-catalog/system-environments/23b554c1-c30c-483d-bf98-dbe9ab7b88a0/associations \
>      -H "x-api-key: <apiKey>"

1 {
2   "meta": {
3     "total": 5,
4     "nextCursor": null,
5     "limit": 5
6   },
7   "data": {
8     "0": {
9       "associatedAt": "2026-03-17T09:48:14.000Z",
10       "id": "ff53b4bc-eeb7-4b13-866a-5fbd79b13137",
11       "workspaceEnvironmentId": "12345678-10ec194c-01eb-4844-91a2-9612fccf59d9",
12       "workspaceId": "47d1b387-2485-482a-bf62-46ddd70a6d1e"
13     },
14     "1": {
15       "associatedAt": "2026-03-17T09:48:14.000Z",
16       "id": "d17e1e36-39e8-420b-8eab-52bbd6a9d414",
17       "workspaceEnvironmentId": "56781234-6c30365c-aa38-4f6f-b544-c8b06acfc48d",
18       "workspaceId": "47d1b387-2485-482a-bf62-46ddd70a6d1e"
19     },
20     "2": {
21       "associatedAt": "2026-03-17T09:48:14.000Z",
22       "id": "cb302fe2-0c2b-48cb-be0f-64a265e153e0",
23       "workspaceEnvironmentId": "87654321-3610b709-275b-488d-9f30-5730fc999905",
24       "workspaceId": "47d1b387-2485-482a-bf62-46ddd70a6d1e"
25     },
26     "3": {
27       "associatedAt": "2026-03-17T09:48:14.000Z",
28       "id": "c248ee20-b817-40f1-bcce-09d4cf4987a6",
29       "workspaceEnvironmentId": "54367812-0877b33f-3fb2-4a9c-b11e-dc634d9b24d0",
30       "workspaceId": "47d1b387-2485-482a-bf62-46ddd70a6d1e"
31     },
32     "4": {
33       "associatedAt": "2026-03-17T09:48:14.000Z",
34       "id": "7e63f482-458c-453c-83f8-dc29f49b00b1",
35       "workspaceEnvironmentId": "12345678-46ea6b0e-2fa7-40f4-afe1-2e409724d41c",
36       "workspaceId": "47d1b387-2485-482a-bf62-46ddd70a6d1e"
37     },
38     "id": "ff53b4bc-eeb7-4b13-866a-5fbd79b13137",
39     "workspaceEnvironmentId": "12345678-10ec194c-01eb-4844-91a2-9612fccf59d9",
40     "workspaceId": "47d1b387-2485-482a-bf62-46ddd70a6d1e",
41     "associatedAt": "2026-03-17T09:48:14.000Z"
42   }
43 }

Gets the workspace-environment associations for a system environment.

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

systemEnvironmentIdstringRequired

The system environment's ID.

Query parameters

workspaceIdstringOptional

The workspace's ID to which the environments in the association belong to.

limitintegerOptional1-100Defaults to 20

The maximum number of rows to return in the response, up to a maximum value of 100. Any value greater than 100 returns a 400 Bad Request response.

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

metaobject

The response's meta information for paginated results.

dataobject

Information about the workspace-environment association.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error