Workspaces

Endpoints for managing and maintaining workspaces in an organization

List workspaces

Returns a paginated list of all workspaces that you have a role to access in your organization. For a list of all workspaces regardless of your user role, see the 'Admin' equivalent API.

Create workspace

Creates a new workspace in your organization.

List Workspaces Summary

Delete workspace

Deletes a workspace. Use of this API requires an 'owner' role in the workspace. Deleted workspaces will no longer be returned in 'get workspace' and 'list workspace' requests, however you can include them by appending deleted=true to your request parameters.

Get workspace

Returns a workspace by its ID, provided your user has a role to access it. To retrieve a workspace by ID regardless of your user role, see the 'Admin' equivalent API.

Update workspace

Updates a workspace.

Restore a deleted workspace

If a workspace has been soft deleted, this API allows you to restore it again. After restoring, the workspace will no longer be included in 'get workspace' and 'list workspace' when the deleted=true parameter is appended to your request parameters.

Get current user role

Returns your user account's role in a workspace.

List users

Returns a list of all users with a role in a workspace.

Assign user role

Assigns a user a role in a workspace.

Remove user from workspace

Removes a user by removing their role from the workspace.