Platform
Platform: Workspace Detail
A workspace's members, this month's usage, totals, provider overrides, recent failed jobs and suspension (platform staff). Audited as `workspace.viewed`.
API key access
Not available to API keys or connected apps: only a signed-in person can call this route.
GET
/api/v1/platform/workspaces/{workspace_id}AuthorizationBearer <token>
Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Path Parameters
workspace_idstring
Format
uuidResponse Body
curl -X GET "http://localhost:8000/api/v1/platform/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"workspace": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"slug": "string",
"plan": "string",
"country": "string",
"members": 0,
"owner_email": "string",
"created_at": "2019-08-24T14:15:22Z",
"suspended_at": "2019-08-24T14:15:22Z",
"suspended_reason": "string",
"emails_sent_30d": 0,
"calls_30d": 0,
"ai_calls_30d": 0
},
"timezone": "string",
"suspended_at": "2019-08-24T14:15:22Z",
"suspended_by_email": "string",
"members": [
{
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"email": "string",
"name": "string",
"role": "owner",
"joined_at": "2019-08-24T14:15:22Z"
}
],
"period_start": "2019-08-24T14:15:22Z",
"usage": {
"emails_sent": 0,
"calls": 0,
"call_minutes": 0,
"ai_calls": 0,
"leads_created": 0
},
"totals": {
"leads": 0,
"companies": 0,
"active_campaigns": 0,
"kb_documents": 0
},
"providers": [
{
"kind": "string",
"provider": "string",
"credentials_configured": true
}
],
"recent_failed_jobs": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "string",
"state": "string",
"attempts": 0,
"last_error": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}Empty
Empty
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}