API referenceWorkspaces

Get the credential's workspace

Personal access tokens are supported. Service-account workspace reads remain disabled until the workspace read model supports non-human principals.

GET
/api/v1/workspaces/{workspaceId}

Personal access tokens are supported. Service-account workspace reads remain disabled until the workspace read model supports non-human principals.

Authorization

machineBearer
AuthorizationBearer <token>

Personal access tokens and supported service-account keys are accepted only in the Authorization header and never in URLs. Each operation documents which principal types it authorizes.

In: header

Path Parameters

workspaceId*string

Workspace UUID. It must match the workspace bound to the credential.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "slug": "string",    "name": "string",    "color": "string",    "avatarUrl": "http://example.com",    "active": true,    "role": "guest",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}