v3

latestOpenAPI 3.1.02026-07-311725107.3 KB

Workspaces

Get a workspace

Retrieve a single Workspace by its ID or key

get/workspaces/{keyOrId}

Path parameters

keyOrIdstring required

Workspace key or ID

Example:my-workspace

Workspace key or ID

Response

Retrieve the workspace

idstring required

keystring required

avatarUrlstring required

providerUrlstring required

createdAtstring date-time required

updatedAtstring date-time required

Example response

{
  "id": "ws_abc123",
  "key": "my-workspace",
  "avatarUrl": "https://example.com/avatar.png",
  "providerUrl": "https://github.com/my-workspace",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z"
}