Skip to main content
Endpointy workspace pozwalają odczytać informacje o zespole i jego członkach. Wszystkie wymagają nagłówka X-Workspace-Id. Wymagany scope: workspace:read

Informacje o workspace

curl -s https://my.clarife.app/api/v1/workspace \
  -H "Authorization: Bearer clrf_xxxxx" \
  -H "X-Workspace-Id: a1b2c3d4-e5f6-7890-abcd-ef1234567890" | jq
Odpowiedź 200 OK:
{
  "id": "a1b2c3d4-...",
  "name": "Mój zespół",
  "owner_id": "u1234567-...",
  "created_at": "2026-01-15T10:00:00Z",
  "updated_at": "2026-03-28T12:00:00Z",
  "member_count": 5,
  "storage_bytes": 1073741824
}
PoleOpis
owner_idID właściciela workspace
member_countLiczba członków zespołu
storage_bytesAktualne zużycie storage w bajtach

Lista członków

curl -s "https://my.clarife.app/api/v1/workspace/members?limit=20" \
  -H "Authorization: Bearer clrf_xxxxx" \
  -H "X-Workspace-Id: a1b2c3d4-e5f6-7890-abcd-ef1234567890" | jq
Parametry query:
ParametrTypDomyślnieOpis
limitinteger50Wyniki na stronę (1-100)
offsetinteger0Przesunięcie paginacji
Odpowiedź 200 OK:
{
  "data": [
    {
      "id": "wm1234-...",
      "user_id": "u1234567-...",
      "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-15T10:00:00Z",
      "display_name": "Jan Kowalski",
      "avatar_url": "https://...",
      "email": "jan@firma.pl"
    },
    {
      "id": "wm5678-...",
      "user_id": "u5678901-...",
      "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-03-01T10:00:00Z",
      "display_name": "Anna Nowak",
      "avatar_url": null,
      "email": "a***@firma.pl"
    }
  ],
  "total": 2,
  "limit": 20,
  "offset": 0
}
Adresy email członków są maskowane (np. a***@firma.pl) dla wszystkich poza właścicielem workspace. Właściciel widzi pełne adresy.

Uprawnienia członków

UprawnienieOpis
can_create_documentsTworzenie dokumentów w workspace
can_edit_documentsEdycja dokumentów workspace
can_delete_documentsUsuwanie dokumentów workspace
can_generate_videoGenerowanie wideo AI
can_manage_sharesZarządzanie linkami udostępniania
can_manage_brandingZarządzanie brandingami
can_invite_membersZapraszanie nowych członków
can_use_apiDostęp do API
Aby korzystać z API w kontekście workspace, członek musi mieć uprawnienie can_use_api ustawione na true.