Workspace

Endpoints

Method	Path	Scope	Description
GET	/workspace	workspace:read	Get workspace details
GET	/workspace/members	workspace:read	List workspace members

ℹ️ Info: Workspace endpoints require the X-Workspace-Id header.

Get Workspace

bash

curl https://my.clarife.app/api/v1/workspace \
  -H "Authorization: Bearer clrf_your_key" \
  -H "X-Workspace-Id: a1b2c3d4-5678-90ab-cdef-1234567890ab"

Response:

json

{
  "data": {
    "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "name": "Acme Corp",
    "owner_id": "u1a2b3c4-...",
    "created_at": "2026-01-15T09:00:00Z",
    "updated_at": "2026-03-28T12:00:00Z",
    "member_count": 8,
    "storage_bytes": 1073741824
  }
}

List Members

bash

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"

Query parameters:

Param	Type	Default	Description
limit	integer	50	Results per page (max 100)
offset	integer	0	Number of results to skip

Response:

json

{
  "data": [
    {
      "id": "wm1234-...",
      "user_id": "u1a2b3c4-...",
      "role": "owner",
      "can_create_documents": true,
      "can_edit_documents": true,
      "can_delete_documents": true,
      "can_generate_video": true,
      "can_manage_shares": true,
      "can_manage_branding": true,
      "can_invite_members": true,
      "can_use_api": true,
      "created_at": "2026-01-15T09:00:00Z",
      "display_name": "Jane Doe",
      "avatar_url": "https://...",
      "email": "jane@acme.com"
    },
    {
      "id": "wm5678-...",
      "user_id": "u2b3c4d5-...",
      "role": "member",
      "can_create_documents": true,
      "can_edit_documents": true,
      "can_delete_documents": false,
      "can_generate_video": false,
      "can_manage_shares": false,
      "can_manage_branding": false,
      "can_invite_members": false,
      "can_use_api": false,
      "created_at": "2026-02-01T14:00:00Z",
      "display_name": "Bob Smith",
      "avatar_url": null,
      "email": "b***@acme.com"
    }
  ],
  "total": 2,
  "limit": 20,
  "offset": 0
}

ℹ️ Info: Member email addresses are masked (e.g. b***@acme.com) for everyone except the workspace owner. The owner sees full addresses.

Member Permissions

Permission	Description
can_create_documents	Create documents in the workspace
can_edit_documents	Edit workspace documents
can_delete_documents	Delete workspace documents
can_generate_video	Generate AI videos
can_manage_shares	Manage share links
can_manage_branding	Manage brandings
can_invite_members	Invite new members
can_use_api	Access the API in the workspace context

ℹ️ Note: The workspace endpoints are read-only. To manage members or change permissions, use the clarife dashboard under Settings > Team.