Cut.ProDocs
Account: workspace

Get current workspace

Returns information about the workspace this request resolved to: name, plan, credit balance, member count and the role of the user who created the key.

A key bound to one workspace always resolves to it. A key bound to several resolves to the one in the X-Workspace-Id header, so call this whenever you need to confirm which workspace a request is actually hitting.

Authorization

apiKey
X-Api-Key<token>

In: header

Response Body

application/json

application/json

GET
/workspace
curl -X GET "https://example.com/workspace"
{  "id": "string",  "name": "string",  "is_personal": true,  "status": "string",  "role": "admin",  "plan_id": "string",  "plan_name": "string",  "plan_is_free": true,  "credits": 0,  "credits_unlimited": true,  "credits_unlimited_until": "string",  "seat_count": 0,  "max_total_seats": 0,  "member_count": 0,  "created_at": "string"}