workspace-registry

List all workspaces

Changed on
get/workspaces

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces
  • Auth: HTTP bearer

Response

Workspace list

accountLoginstring required

Git provider account login associated with this workspace

createdAtstring date-time required

Timestamp when the workspace was created

displayNamestring required

Human-readable name of the workspace

idinteger required

Unique identifier of the workspace

practicesEnabledboolean required

Whether practice reviews are on

providerType'GITHUB' | 'GITLAB' | 'SLACK' | 'OUTLINE'

High-level git provider type (GITHUB or GITLAB), or null if no SCM connection bound

publishesPublicActivityboolean required

Whether the public activity page is live: the instance allows it and the workspace turned it on

statusstring required

Current lifecycle status of the workspace (PENDING, ACTIVE, ARCHIVED)

workspaceAddressstring required

Canonical workspace address. Uses the apex path when subdomains are off.

workspaceSlugstring required

URL-friendly identifier for the workspace

Example response

[
  {
    "workspaceSlug": "my-workspace"
  }
]

Changes