Method
GET /v1/workspaces/:id
Path Parameters
uuid
required
Workspace identifier. Must match the workspace associated with the API key.
Headers
string
Bearer token with
workspaces:read scope.curl "https://api.voyantcloud.com/v1/workspaces/ws_abc" \
-H "Authorization: Bearer $VOYANT_API_KEY"
const res = await fetch("https://api.voyantcloud.com/v1/workspaces/ws_abc", {
headers: { Authorization: `Bearer ${process.env.VOYANT_API_KEY}` },
})
const body = await res.json()
import os, requests
resp = requests.get(
"https://api.voyantcloud.com/v1/workspaces/ws_abc",
headers={"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}"},
)
workspace = resp.json()
{
"data": {
"id": "ws_abc",
"name": "Voyant Travel",
"slug": "voyant-travel",
"icon_asset_id": "asset_123"
}
}
{ "error": "Access denied", "code": "AUTH_403" }
{ "error": "Workspace not found", "code": "NOT_FOUND_404" }
Workspaces
Get Workspace
Return basic workspace metadata (id, name, slug, icon).
curl "https://api.voyantcloud.com/v1/workspaces/ws_abc" \
-H "Authorization: Bearer $VOYANT_API_KEY"
const res = await fetch("https://api.voyantcloud.com/v1/workspaces/ws_abc", {
headers: { Authorization: `Bearer ${process.env.VOYANT_API_KEY}` },
})
const body = await res.json()
import os, requests
resp = requests.get(
"https://api.voyantcloud.com/v1/workspaces/ws_abc",
headers={"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}"},
)
workspace = resp.json()
{
"data": {
"id": "ws_abc",
"name": "Voyant Travel",
"slug": "voyant-travel",
"icon_asset_id": "asset_123"
}
}
{ "error": "Access denied", "code": "AUTH_403" }
{ "error": "Workspace not found", "code": "NOT_FOUND_404" }