Sign in
WorkspaceAdminService
Workspace Admin

Get a workspace by ID

Retrieves a workspace in the account by ID. Admin only.

get/v1/account/workspaces/{workspaceId}

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

Workspace ID to retrieve (path).

Response

OK

status'STATUS_ENABLED' | 'STATUS_DISABLED' | 'STATUS_ARCHIVED' enum

Lifecycle status of the workspace. Archived workspaces reject all requests scoped to them. Server-populated.

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  }
}

Changes

Changed in 2 of the 57 revisions of this API.3

  • 06e0e37c14992See the full diff
    • ○

      added the optional property info to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property metadata/createdAt to the response with the 200 status

      response-optional-property-added

    This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4648e10e02561See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog