Endpoints
| Method | Path | Scope | Description |
|---|
GET | /workspace | workspace:read | Get workspace details |
GET | /workspace/members | workspace:read | List workspace members |
Workspace endpoints require the X-Workspace-Id header. Without it, the request targets your personal workspace.
Get Workspace
curl https://my.clarife.app/api/v1/workspace \
-H "Authorization: Bearer clrf_your_key" \
-H "X-Workspace-Id: a1b2c3d4-5678-90ab-cdef-1234567890ab"
{
"data": {
"id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"name": "Acme Corp",
"owner_id": "u1a2b3c4-...",
"plan": "business",
"member_count": 8,
"created_at": "2026-01-15T09:00:00Z"
}
}
List Members
curl "https://my.clarife.app/api/v1/workspace/members?limit=20" \
-H "Authorization: Bearer clrf_your_key" \
-H "X-Workspace-Id: a1b2c3d4-5678-90ab-cdef-1234567890ab"
| Param | Type | Default | Description |
|---|
limit | integer | 50 | Results per page (max 100) |
offset | integer | 0 | Number of results to skip |
{
"data": [
{
"id": "u1a2b3c4-...",
"email": "jane@acme.com",
"name": "Jane Doe",
"role": "owner",
"joined_at": "2026-01-15T09:00:00Z"
},
{
"id": "u2b3c4d5-...",
"email": "bob@acme.com",
"name": "Bob Smith",
"role": "editor",
"joined_at": "2026-02-01T14:00:00Z"
}
],
"total": 2,
"limit": 20,
"offset": 0
}
Member Roles
| Role | Description |
|---|
owner | Full control over the workspace, billing, and members |
admin | Can manage members, projects, and all documents |
editor | Can create and edit documents, projects, and shares |
viewer | Read-only access to documents and projects |
The workspace endpoints are read-only. To manage members or change roles, use the clarife dashboard under Settings > Team.
