getWorkspace
Retrieve workspace details including visibility settings and optional information like deactivated mocks or SCIM user IDs.
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 (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).
Input 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. |