getWorkspace
Retrieve workspace details including visibility settings, collections, environments, and access permissions to manage API collaboration in Postman.
Instructions
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 (Professional).
`public` — Everyone can access the workspace.
`partner` — Only invited team members and partners can access the workspace (Professional).
Important
We have deprecated the `name` and `uid` responses in the following array of objects:
`collections`
`environments`
`mocks`
`monitors`
`apis`
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workspaceId | Yes | The workspace's ID. | |
| include | No | 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. |