Skip to main content

​
Method

GET /v1/workspaces/:id

​
Path Parameters

​
id
uuid
required
Workspace identifier. Must match the workspace associated with the API key.

​
Headers

​
Authorization
string
Bearer token with workspaces:read scope.

​
Request Example

curl "https://api.voyantcloud.com/v1/workspaces/ws_abc" \
  -H "Authorization: Bearer $VOYANT_API_KEY"

​
Response

{
  "data": {
    "id": "ws_abc",
    "name": "Voyant Travel",
    "slug": "voyant-travel",
    "icon_asset_id": "asset_123"
  }
}
The API validates that the requested :id matches the workspace in the API key context. Service accounts operating across multiple workspaces must rotate keys or proxy requests through an internal service.