Preskočiť na obsah
Sursa Developers

GET/v1/groups

Zobraziť skupiny organizácie

list_groups

Bez kind vráti bežné skupiny, „All members“ a skupiny rolí. Osobné skupiny (single_user) sa vrátia len s výslovným kind=single_user. Členstvo v skupinách all_members, role a single_user sa vypočítava z používateľov organizácie, rovnako ako ich members_count.

Autentifikácia

Odošlite kľúč API v hlavičke Authorization: Authorization: Bearer <kľúč>.

Parametre dotazu

  • kindGroupKind
  • limitinteger

    Veľkosť stránky. Bez limit a cursor sa vráti celý zoznam; s ním najviac limit položiek a ďalšia stránka je uvedená v hlavičkách Link (rel="next") a X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Kurzor ďalšej stránky z X-Next-Cursor alebo z next_cursor predchádzajúcej odpovede s rovnakými filtrami; nesie aj veľkosť stránky. Spolu s offset: 422 validation.failed; kurzor iného zoznamu, s inými filtrami alebo poškodený: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Len objekty s updated_at v tomto okamihu alebo neskôr (RFC 3339 s časovým posunom), na synchronizáciu. S ním je zoznam zoradený podľa updated_at vzostupne, potom podľa id, a kurzor pokračuje v tomto poradí. Odstránené objekty sa v zozname neuvádzajú: odstránenia prichádzajú ako udalosti.

    length ≤ 512

Odpovede

200Úspešná odpoveď

Hlavičky odpovede

  • Link

    Adresa ďalšej stránky, <…>; rel="next". Ak hlavička chýba, ide o poslednú stránku.

  • X-Next-Cursor

    Kurzor ďalšej stránky pre parameter cursor. Ak hlavička chýba, ide o poslednú stránku.

  • RateLimit-Policy

    Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.

  • RateLimit

    Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).

  • X-RateLimit-Remaining

    Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.

  • X-RateLimit-Reset

    Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: GroupList

array of Group
  • idintegerpovinné
  • org_idintegerpovinné
  • keystringpovinné

    Stabilný kľúč: all, role:<role>, user:<id> alebo kľúč bežnej skupiny. Rozhranie prekladá vstavané skupiny podľa kľúča.

  • titlestringpovinné
  • kindGroupKindpovinné
  • user_idinteger | nullpovinné

    Len osobné skupiny.

  • role_keyRole | nullpovinné

    Len skupiny rolí.

  • managed_byGroupManagedBypovinné
  • members_countintegerpovinné

    Počet aktívnych členov. Deaktivovaní používatelia nie sú členmi skupín.

  • disabledbooleanpovinné

    Osobná skupina deaktivovaného používateľa: jej priradenia sa zachovávajú, ale kým je používateľ neaktívny, nemajú účinok. Pri všetkých ostatných skupinách false.

  • created_atstring (date-time)povinné
  • updated_atstring (date-time)povinné
401Neboli odoslané žiadne prihlasovacie údaje (ani cookie relácie, ani kľúč API) alebo sa kľúč nenašiel.

Hlavičky odpovede

  • RateLimit-Policy

    Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.

  • RateLimit

    Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).

  • X-RateLimit-Remaining

    Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.

  • X-RateLimit-Reset

    Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

422Chyba validácie: telo alebo parametre nezodpovedajú schéme (`detail` je zoznam chýb validácie) alebo je hodnota parametra mimo rozsahu (`detail` je správa).

Hlavičky odpovede

  • RateLimit-Policy

    Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.

  • RateLimit

    Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).

  • X-RateLimit-Remaining

    Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.

  • X-RateLimit-Reset

    Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

429Príliš veľa požiadaviek (`api.rate_limited`), vyčerpaná kvóta organizácie na minútu, deň alebo mesiac (`api.quota_exceeded`; `error.details` obsahuje `quota`, `limit` a `reset_at`), dosiahnutý limit organizácie alebo zaneprázdnená služba odpovedí (`answers.engine_busy`). Počkajte čas uvedený v hlavičke `Retry-After`.

Hlavičky odpovede

  • Retry-After

    Počet sekúnd, ktoré treba počkať pred opakovaním požiadavky.

  • RateLimit-Policy

    Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.

  • RateLimit

    Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).

  • X-RateLimit-Remaining

    Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.

  • X-RateLimit-Reset

    Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

Chybové kódy

Kódy, ktoré táto operácia môže vrátiť v error.code, okrem všeobecných kódov každej požiadavky.

Limity frekvencie

Odpovede obsahujú hlavičky RateLimit a RateLimit-Policy a staršie X-RateLimit-Limit, X-RateLimit-Remaining a X-RateLimit-Reset. Odpoveď 429 má hlavičku Retry-After v sekundách: počkajte a požiadavku zopakujte.

← groups · Referencia API