Salt la conținut
Sursa Developers

GET/v1/groups

Listează grupurile organizației

list_groups

Fără kind, returnează grupurile obișnuite, „All members” (toți membrii) și grupurile de rol. Grupurile personale (single_user) sunt returnate doar cu un kind=single_user explicit. Componența grupurilor all_members, role și single_user este calculată din utilizatorii organizației, la fel și members_count al lor.

Autentificare

Trimiteți o cheie API în antetul Authorization: Authorization: Bearer <cheie>.

Parametri de interogare

  • kindGroupKind
  • limitinteger

    Dimensiunea paginii. Fără limit și cursor se returnează întreaga listă; dacă este setat, cel mult limit elemente, iar pagina următoare este indicată în antetele Link (rel="next") și X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Cursorul paginii următoare din X-Next-Cursor sau next_cursor al răspunsului anterior, cu aceleași filtre; el conține dimensiunea paginii. Împreună cu offset: 422 validation.failed; un cursor al altei liste, cu alte filtre sau malformat: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Doar obiectele cu updated_at egal cu acest moment sau ulterior lui (RFC 3339 cu decalajul fusului orar), pentru sincronizare. Cu el, lista este sortată după updated_at crescător, apoi după id, iar cursorul continuă în această ordine. Obiectele șterse nu sunt listate: ștergerile vin ca evenimente.

    length ≤ 512

Răspunsuri

200Răspuns reușit

Antetele răspunsului

  • Link

    Adresa paginii următoare, <…>; rel="next". Lipsa antetului înseamnă că aceasta este ultima pagină.

  • X-Next-Cursor

    Cursorul paginii următoare pentru parametrul cursor. Lipsa antetului înseamnă că aceasta este ultima pagină.

  • RateLimit-Policy

    Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.

  • RateLimit

    Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).

  • X-RateLimit-Remaining

    Cereri rămase în cadrul celei mai stricte limite.

  • X-RateLimit-Reset

    Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: GroupList

array of Group
  • idintegerobligatoriu
  • org_idintegerobligatoriu
  • keystringobligatoriu

    Cheie stabilă: all, role:<role>, user:<id> sau cheia unui grup obișnuit. Interfața traduce grupurile predefinite după cheie.

  • titlestringobligatoriu
  • kindGroupKindobligatoriu
  • user_idinteger | nullobligatoriu

    Doar pentru grupurile personale.

  • role_keyRole | nullobligatoriu

    Doar pentru grupurile de rol.

  • managed_byGroupManagedByobligatoriu
  • members_countintegerobligatoriu

    Numărul de membri activi. Utilizatorii dezactivați nu sunt membri ai grupurilor.

  • disabledbooleanobligatoriu

    Grupul personal al unui utilizator dezactivat: acordările lui se păstrează, dar nu au efect cât timp utilizatorul este inactiv. false pentru toate celelalte grupuri.

  • created_atstring (date-time)obligatoriu
  • updated_atstring (date-time)obligatoriu
401Nu au fost trimise date de autentificare (nici cookie de sesiune, nici cheie API) sau cheia nu a fost găsită.

Antetele răspunsului

  • RateLimit-Policy

    Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.

  • RateLimit

    Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).

  • X-RateLimit-Remaining

    Cereri rămase în cadrul celei mai stricte limite.

  • X-RateLimit-Reset

    Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

422Eroare de validare: corpul sau parametrii nu corespund schemei (`detail` este o listă de erori de validare) ori valoarea unui parametru este în afara intervalului permis (`detail` este un mesaj).

Antetele răspunsului

  • RateLimit-Policy

    Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.

  • RateLimit

    Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).

  • X-RateLimit-Remaining

    Cereri rămase în cadrul celei mai stricte limite.

  • X-RateLimit-Reset

    Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

429Prea multe cereri (`api.rate_limited`), cota organizației pentru minut, zi sau lună este epuizată (`api.quota_exceeded`; `error.details` conține `quota`, `limit` și `reset_at`), limita organizației este atinsă sau serviciul de răspunsuri este ocupat (`answers.engine_busy`). Așteptați timpul indicat în antetul `Retry-After`.

Antetele răspunsului

  • Retry-After

    Numărul de secunde de așteptat înainte de a reîncerca cererea.

  • RateLimit-Policy

    Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.

  • RateLimit

    Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).

  • X-RateLimit-Remaining

    Cereri rămase în cadrul celei mai stricte limite.

  • X-RateLimit-Reset

    Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

Coduri de eroare

Codurile pe care acest endpoint le poate returna în error.code, pe lângă codurile generale ale oricărei cereri.

Limite de frecvență

Răspunsurile conțin antetele RateLimit și RateLimit-Policy, precum și antetele anterioare X-RateLimit-Limit, X-RateLimit-Remaining și X-RateLimit-Reset. Un răspuns 429 conține Retry-After în secunde: așteptați și reîncercați.

← groups · Referința API