Get all workspaces

GET

/network/private

GET

/network/private

$ curl https://api.getpostman.com/network/private \
>      -H "x-api-key: <apiKey>"

1 {
2   "elements": [
3     {
4       "createdAt": "2024-11-29T06:31:24.000Z",
5       "createdBy": 12345678,
6       "updatedAt": "2024-11-29T06:31:24.000Z",
7       "updatedBy": 12345678,
8       "addedAt": "2024-11-29T06:31:24.000Z",
9       "addedBy": 12345678,
10       "description": null,
11       "id": "5360b75f-447e-467c-9299-12fd6c92450d",
12       "name": "Billing Team Workspace",
13       "summary": "The Billing team's workspace.",
14       "type": "workspace",
15       "href": "https://api.getpostman.com/workspaces/1f0df51a-8658-4ee8-a2a1-d2567dfa09a9",
16       "parentFolderId": 0
17     },
18     {
19       "createdAt": "2024-11-29T06:31:26.000Z",
20       "createdBy": 12345678,
21       "updatedAt": "2024-11-29T06:31:26.000Z",
22       "updatedBy": 12345678,
23       "addedAt": "2024-11-29T06:31:26.000Z",
24       "addedBy": 12345678,
25       "description": null,
26       "id": "360b75f-447e-467c-9299-12fd3c92450d",
27       "name": "Test Workspace",
28       "summary": "This is a test workspace.",
29       "type": "workspace",
30       "href": "https://api.getpostman.com/workspaces/41f6dc6d-d8ab-45c6-8506-74a25acf5d5f",
31       "parentFolderId": 0
32     }
33   ],
34   "meta": {
35     "limit": 1000,
36     "offset": 0,
37     "totalCount": 2
38   },
39   "folders": []
40 }

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

Gets information workspaces added to your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).

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

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.

Return only results created since the given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) 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.

Return only results created until this given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) 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 objects

A list of Private API Network elements.

metaobject

The response’s non-standard meta information.

folderslist of objectsDeprecated

This property is deprecated and only returns an empty array.

Errors

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error