Get all workspaces

GET

/network/private

GET

/network/private

curl -G https://api.postman.com/network/private \
     -H "x-api-key: <apiKey>" \
     -d addedBy=12345678 \
     -d createdBy=12345678 \
     -d description=payments \
     -d direction=asc \
     -d limit=10 \
     -d name=billing \
     -d offset=5 \
     -d parentFolderId=1 \
     --data-urlencode since=2022-06-01T00:00:00.000Z \
     -d sort=updatedAt \
     -d summary=payments \
     -d type=workspace \
     --data-urlencode until=2022-06-15T00:00:00.000Z

{
  "elements": [
    {
      "createdAt": "2024-11-29T06:31:24.000Z",
      "createdBy": 12345678,
      "updatedAt": "2024-11-29T06:31:24.000Z",
      "updatedBy": 12345678,
      "addedAt": "2024-11-29T06:31:24.000Z",
      "addedBy": 12345678,
      "description": null,
      "id": "5360b75f-447e-467c-9299-12fd6c92450d",
      "name": "Billing Team Workspace",
      "summary": "The Billing team's workspace.",
      "type": "workspace",
      "href": "https://api.postman.com/workspaces/1f0df51a-8658-4ee8-a2a1-d2567dfa09a9",
      "parentFolderId": 0
    },
    {
      "createdAt": "2024-11-29T06:31:26.000Z",
      "createdBy": 12345678,
      "updatedAt": "2024-11-29T06:31:26.000Z",
      "updatedBy": 12345678,
      "addedAt": "2024-11-29T06:31:26.000Z",
      "addedBy": 12345678,
      "description": null,
      "id": "360b75f-447e-467c-9299-12fd3c92450d",
      "name": "Test Workspace",
      "summary": "This is a test workspace.",
      "type": "workspace",
      "href": "https://api.postman.com/workspaces/41f6dc6d-d8ab-45c6-8506-74a25acf5d5f",
      "parentFolderId": 0
    }
  ],
  "meta": {
    "limit": 1000,
    "offset": 0,
    "totalCount": 2
  },
  "folders": []
}

Gets information workspaces added to your team’s Private API Network.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

typeenumOptional

The workspace value.

Allowed values:

namestringOptional

Return only workspaces whose name includes the given value. Matching is not case-sensitive.

summarystringOptional

Return only workspaces whose summary includes the given value. Matching is not case-sensitive.

descriptionstringOptional

Return only workspaces whose description includes the given value. Matching is not case-sensitive.

sincedatetimeOptional

Return only results created since the given time, in ISO 8601 format. This value cannot be later than the until value.

untildatetimeOptional

Return only results created until this given time, in ISO 8601 format. This value cannot be earlier than the since value.

addedByintegerOptional

Return only workspaces published by the given user ID.

sortenumOptional

Sort the results by the given value. If you use this query parameter, you must also use the direction parameter.

Allowed values:

directionenumOptional

Sort in ascending (asc) or descending (desc) order. Matching is not case-sensitive. If you use this query parameter, you must also use the sort parameter.

Allowed values:

createdByintegerOptional

Return only results created by the given user ID.

offsetintegerOptionalDefaults to 0

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

limitintegerOptionalDefaults to 1000

The maximum number of results to return. If the value exceeds the maximum value of 1000, then the system uses the 1000 value.

parentFolderIdintegerOptionalDefaults to 0Deprecated

This parameter is deprecated.

Response

Successful Response

elementslist of objectsOptional

A list of Private API Network elements.

metaobjectOptional

The response’s non-standard meta information.

folderslist of objectsOptionalDeprecated

This property is deprecated and only returns an empty array.

Errors

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error