Get a workspace

GET

/workspaces/:workspaceId

GET

/workspaces/:workspaceId

$ curl https://api.postman.com/workspaces/1f0df51a-8658-4ee8-a2a1-d2567dfa09a9 \
>      -H "x-api-key: <apiKey>"

1 {
2   "workspace": {
3     "id": "1f0df51a-8658-4ee8-a2a1-d2567dfa09a9",
4     "name": "Team Workspace",
5     "type": "team",
6     "description": "This is a team workspace.",
7     "visibility": "team",
8     "createdBy": "12345678",
9     "updatedBy": "12345678",
10     "createdAt": "2022-07-06T16:18:32.000Z",
11     "updatedAt": "2022-07-06T20:55:13.000Z",
12     "about": "Team workspace.",
13     "collections": [
14       {
15         "id": "12ece9e1-2abf-4edc-8e34-de66e74114d2",
16         "name": "Test Collection",
17         "uid": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"
18       }
19     ],
20     "environments": [
21       {
22         "id": "5daabc50-8451-43f6-922d-96b403b4f28e",
23         "name": "Test Environment",
24         "uid": "12345678-5daabc50-8451-43f6-922d-96b403b4f28e"
25       }
26     ],
27     "mocks": [
28       {
29         "id": "e3d951bf-873f-49ac-a658-b2dcb91d3289",
30         "name": "Test Mock",
31         "uid": "12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289",
32         "deactivated": false
33       }
34     ],
35     "monitors": [
36       {
37         "id": "1e6b6cc1-c760-48e0-968f-4bfaeeae9af1",
38         "name": "Test Monitor",
39         "uid": "12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1",
40         "deactivated": false
41       }
42     ],
43     "specs": [
44       {
45         "id": "73e15000-bc7a-4802-b80e-05fff18fd7f8",
46         "name": "Sample API",
47         "uid": "12345678-73e15000-bc7a-4802-b80e-05fff18fd7f8"
48       }
49     ],
50     "apis": [
51       {
52         "id": "387c2863-6ee3-4a56-8210-225f774edade",
53         "name": "Test API",
54         "uid": "12345678-387c2863-6ee3-4a56-8210-225f774edade"
55       }
56     ]
57   }
58 }

Gets information about a workspace.

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

Gets information about a workspace. **Note:** This endpoint's response contains the `visibility` field. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-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](https://www.postman.com/pricing)). - `public` — Everyone can access the workspace. - `partner` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)).

Authentication

x-api-keystring

API Key authentication via header

Path parameters

workspaceIdstringRequired

The workspace's ID.

Query parameters

includestringOptional

format: "^(?!.*(?:^|,)(team|scim|mocks:deactivated),(?:.*,)?\1(?:$|,))(team|scim|mocks:deactivated)(,(team|scim|mocks:deactivated))*$"

A comma-separated list of values to include in the endpoint’s response:

scim — Return the SCIM user IDs of the workspace creator and who last modified it.
team — Return the workspace’s team ID. Returns a null value if the workspace isn’t associated with a team.
mocks:deactivated — Include all deactivated mock servers in the response.

A comma-separated list of values to include in the endpoint's response: - `scim` — Return the SCIM user IDs of the workspace creator and who last modified it. - `team` — Return the workspace's team ID. Returns a null value if the workspace isn't associated with a team. - `mocks:deactivated` — Include all deactivated mock servers in the response.

Response

Successful Response

workspaceobjectOptional

Information about the workspace.

Errors

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error