API Workspace
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
bash
curl -s https://my.clarife.app/api/v1/workspace \
-H "Authorization: Bearer clrf_xxxxx" \
-H "X-Workspace-Id: a1b2c3d4-e5f6-7890-abcd-ef1234567890" | jqOdpowiedź 200 OK:
json
{
"data": {
"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
}
}| Pole | Opis |
|---|---|
| owner_id | ID właściciela workspace |
| member_count | Liczba członków zespołu |
| storage_bytes | Aktualne zużycie storage w bajtach |
Lista członków
bash
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" | jqParametry query:
| Parametr | Typ | Domyślnie | Opis |
|---|---|---|---|
| limit | integer | 50 | Wyniki na stronę (1-100) |
| offset | integer | 0 | Przesunięcie paginacji |
Odpowiedź 200 OK:
json
{
"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
}ℹ️ Informacja: 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
| Uprawnienie | Opis |
|---|---|
| can_create_documents | Tworzenie dokumentów w workspace |
| can_edit_documents | Edycja dokumentów workspace |
| can_delete_documents | Usuwanie dokumentów workspace |
| can_generate_video | Generowanie wideo AI |
| can_manage_shares | Zarządzanie linkami udostępniania |
| can_manage_branding | Zarządzanie brandingami |
| can_invite_members | Zapraszanie nowych członków |
| can_use_api | Dostęp do API |
⚠️ Uwaga: Aby korzystać z API w kontekście workspace, członek musi mieć uprawnienie can_use_api ustawione na true.