Initial API EndpointsWorkspaces

Get Workspace

Beta
Retrieve a single Workspace by its ID or key

Path parameters

keyOrIdstringRequired
The key or ID of the Workspace to retrieve

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

This endpoint returns an object.
idstring
The UUID of the Workspace
keystring
The unique key identifier for the Workspace
avatarUrlstring
URL to the Workspace's avatar or logo image
providerUrlstring

URL to the Workspace on the provider platform (e.g., GitHub organization URL)

createdAtdatetime
Timestamp when the Workspace was created
updatedAtdatetime
Timestamp when the Workspace was last updated

Errors