Workspaces

Get Workspace

Changed on

Get workspace details.

Returns details about the workspace associated with the user's session.

Returns: Workspace: The details of the workspace.

Raises: HTTPException: If the user does not have permission to perform this action.

get/workspaces

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/workspaces
  • Auth
    API key in header Authorization

Response

Successful Response

idstring nullable
namestring required
descriptionstring nullable
typestring nullable required

Changes