Workspaces

Get a workspace

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.
get/v2/workspaces/{workspaceId}

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required

Unique identifier of the workspace.

Response

The response body.

workspaceIdstring required
workspaceUrlIdstring required

Base62-encoded identifier used in Sigma workspace URLs.

namestring required
createdBystring required
updatedBystring required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.