get single workspace

GET https://api.getpostman.com/workspaces/{{workspaceId}}

Gets information about a workspace.

Note:

This endpoint's response also 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 ([Professional and Enterprise plans only]

• public — Everyone can access the workspace.

• partner — Only invited team members and [partners] can access the workspace ([Professional and Enterprise plans only]

Important

We have deprecated the name and uid responses in the following array of objects:

• collections
• environments
• mocks
• monitors
• apis

Request Params

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

HEADERS

RESPONSES

status: OK

{"workspace":{"id":"1f0df51a-8658-4ee8-a2a1-d2567dfa09a9","name":"Partner Workspace","type":"team","description":"This is a partner workspace.","visibility":"partner","createdBy":"12345678","updatedBy":"12345678","createdAt":"2022-07-06T16:18:32.000Z","updatedAt":"2022-07-06T20:55:13.000Z","collections":[{"id":"12ece9e1-2abf-4edc-8e34-de66e74114d2","name":"Test Collection","uid":"12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"}],"environments":[{"id":"5daabc50-8451-43f6-922d-96b403b4f28e","name":"Test Environment","uid":"12345678-5daabc50-8451-43f6-922d-96b403b4f28e"}],"mocks":[{"id":"e3d951bf-873f-49ac-a658-b2dcb91d3289","name":"Test Mock","uid":"12345678-e3d951bf-873f-49ac-a658-b2dcb91d3289","deactivated":false}],"monitors":[{"id":"1e6b6cc1-c760-48e0-968f-4bfaeeae9af1","name":"Test Monitor","uid":"12345678-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1"}],"apis":[{"id":"387c2863-6ee3-4a56-8210-225f774edade","name":"Test API","uid":"12345678-387c2863-6ee3-4a56-8210-225f774edade"}]}}