Get all workspaces

GET

/workspaces

GET

/workspaces

curl -G https://api.postman.com/workspaces \
     -H "x-api-key: <apiKey>" \
     -d createdBy=12345678 \
     -d cursor=RnJpIEZlYiAyNCAyMDIzIDEzOjI0OjA5IEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk \
     -d elementId=12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2 \
     -d elementType=collection \
     -d include=scim \
     -d limit=5 \
     -d type=team

{
  "workspaces": [
    {
      "id": "1f0df51a-8658-4ee8-a2a1-d2567dfa09a9",
      "name": "My Workspace",
      "type": "personal",
      "visibility": "personal",
      "createdBy": "12345678",
      "about": "This is a personal workspace.",
      "createdAt": "2022-07-18T06:57:37.000Z",
      "updatedAt": "2025-05-30T08:49:54.000Z"
    },
    {
      "id": "a0f46158-1529-11ee-be56-0242ac120002",
      "name": "Private Workspace",
      "type": "team",
      "visibility": "private",
      "createdBy": "12345678",
      "about": "This is a private workspace.",
      "createdAt": "2022-07-18T06:57:37.000Z",
      "updatedAt": "2025-05-30T08:49:54.000Z"
    },
    {
      "id": "f8801e9e-03a4-4c7b-b31e-5db5cd771696",
      "name": "Team Workspace",
      "type": "team",
      "visibility": "team",
      "createdBy": "12345678",
      "about": "This is a team workspace.",
      "createdAt": "2022-07-18T06:57:37.000Z",
      "updatedAt": "2025-05-30T08:49:54.000Z"
    },
    {
      "id": "74dbfab8-1529-11ee-be56-0242ac120002",
      "name": "Public Workspace",
      "type": "team",
      "visibility": "public",
      "createdBy": "12345678",
      "about": "This is a public workspace.",
      "createdAt": "2022-07-18T06:57:37.000Z",
      "updatedAt": "2025-05-30T08:49:54.000Z"
    },
    {
      "id": "74dbfab8-1529-11ee-be56-0242ac120002",
      "name": "Partner Workspace",
      "type": "team",
      "visibility": "partner",
      "createdBy": "12345678",
      "about": "This is a partner workspace.",
      "createdAt": "2022-07-18T06:57:37.000Z",
      "updatedAt": "2025-05-30T08:49:54.000Z"
    }
  ]
}

Gets all workspaces. The response includes your workspaces and any workspaces that you have access to.

Note:

This endpoint’s response contains the visibility field. Visibility determines who can access the workspace:

personal — Only you can access the workspace.
team — All team members can access the workspace.
private — Only invited team members can access the workspace (Team and Enterprise plans only).
public — Everyone can access the workspace.
partner — Only invited team members and partners can access the workspace (Team and Enterprise plans only).

Authentication

x-api-keystring

API Key authentication via header

Query parameters

typeenumOptional

The type of workspace to filter the response by.

Allowed values:

createdByintegerOptional

Return only workspaces created by a specific user ID. For multiple users, pass this value as a comma-separated list of user IDs. The response only returns workspaces that you have access to.

includeenumOptional

Include the following information in the endpoint’s response:

mocks:deactivated — Include all deactivated mock servers in the response.
scim — Return the SCIM user IDs of the workspace creator and who last modified it.

Allowed values:

elementTypeenumOptional

Filter results to return the workspace where the given element type is located. If you pass this query parameter, you must also pass the elementId query parameter.

Allowed values:

elementIdstringOptional

Filter results to return the workspace where the given element’s ID is located. When filtering by collection, you must use the collection’s unique ID (userId-collection). If you pass this query parameter, you must also pass the elementType query parameter.

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.

limitintegerOptional1-100

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.

Response

Successful Response

workspaceslist of objectsOptional

A list of workspaces.

metaobjectOptional

The response’s meta information for paginated results. This object only returns if you pass the limit query parameter.

Errors

400

Bad Request Error

401

Unauthorized Error

429

Too Many Requests Error

500

Internal Server Error