Skip to navigation

Get a workspace

View as Markdown

This endpoint retrieves the details of a specific workspace by its workspaceId.

Usage notes

Usage scenarios

  • Workspace management: Useful for administrators or users who need to view the details of a specific workspace.
  • Integration checks: Can be used by external systems to verify the existence and status of a workspace as part of integration workflows.

Best practices

  • Validate workspaceId: Ensure the workspaceId provided is valid and corresponds to an existing workspace. Handle any errors gracefully.
  • Access controls: Implement proper authorization checks to ensure that only entitled users can access workspace details.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workspaceIdstringRequired
Unique identifier of the workspace.

Response

The response body.
workspaceIdstring
workspaceUrlIdstring

Base62-encoded identifier used in Sigma workspace URLs.

namestring
createdBystring
updatedBystring
createdAtdatetime
updatedAtdatetime