Preskoči na sadržaj
Sursa Developers

GET/v1/groups

Popis grupa organizacije

list_groups

Bez kind vraća obične grupe, „All members” i grupe uloga. Osobne grupe (single_user) vraćaju se samo uz izričit kind=single_user. Članstvo u grupama all_members, role i single_user izračunava se iz korisnika organizacije, kao i njihov members_count.

Autentifikacija

Pošaljite API ključ u zaglavlju Authorization: Authorization: Bearer <ključ>.

Parametri upita

  • kindGroupKind
  • limitinteger

    Veličina stranice. Bez limit i cursor vraća se cijeli popis; s njim – najviše limit stavki, a sljedeća stranica navodi se u zaglavljima Link (rel="next") i X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Kursor sljedeće stranice iz X-Next-Cursor ili next_cursor prethodnog odgovora s istim filtrima; nosi veličinu stranice. Zajedno s offset: 422 validation.failed; kursor drugog popisa, drugih filtara ili neispravan kursor: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Samo objekti s updated_at u tom trenutku ili nakon njega (RFC 3339 s pomakom), za sinkronizaciju. Uz njega je popis poredan po updated_at uzlazno, zatim po id, a kursor nastavlja tim redoslijedom. Izbrisani objekti nisu na popisu: brisanja stižu kao događaji.

    length ≤ 512

Odgovori

200Uspješan odgovor

Zaglavlja odgovora

  • Link

    Adresa sljedeće stranice, <…>; rel="next". Ako zaglavlja nema, ovo je posljednja stranica.

  • X-Next-Cursor

    Kursor sljedeće stranice za parametar cursor. Ako zaglavlja nema, ovo je posljednja stranica.

  • RateLimit-Policy

    Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.

  • RateLimit

    Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).

  • X-RateLimit-Remaining

    Preostali zahtjevi u okviru najstrožeg ograničenja.

  • X-RateLimit-Reset

    Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: GroupList

array of Group
  • idintegerobavezno
  • org_idintegerobavezno
  • keystringobavezno

    Stalni ključ: all, role:<role>, user:<id> ili ključ obične grupe. Sučelje prevodi ugrađene grupe prema ključu.

  • titlestringobavezno
  • kindGroupKindobavezno
  • user_idinteger | nullobavezno

    Samo osobne grupe.

  • role_keyRole | nullobavezno

    Samo grupe uloga.

  • managed_byGroupManagedByobavezno
  • members_countintegerobavezno

    Broj aktivnih članova. Deaktivirani korisnici nisu članovi grupa.

  • disabledbooleanobavezno

    Osobna grupa deaktiviranog korisnika: njezine dodjele čuvaju se, ali nemaju učinka dok je korisnik neaktivan. false za sve ostale grupe.

  • created_atstring (date-time)obavezno
  • updated_atstring (date-time)obavezno
401Vjerodajnice nisu poslane (ni kolačić sesije ni API ključ) ili ključ nije pronađen.

Zaglavlja odgovora

  • RateLimit-Policy

    Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.

  • RateLimit

    Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).

  • X-RateLimit-Remaining

    Preostali zahtjevi u okviru najstrožeg ograničenja.

  • X-RateLimit-Reset

    Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: Error

422Pogreška provjere valjanosti: tijelo ili parametri ne odgovaraju shemi (`detail` je popis pogrešaka provjere valjanosti) ili je vrijednost parametra izvan raspona (`detail` je poruka).

Zaglavlja odgovora

  • RateLimit-Policy

    Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.

  • RateLimit

    Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).

  • X-RateLimit-Remaining

    Preostali zahtjevi u okviru najstrožeg ograničenja.

  • X-RateLimit-Reset

    Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: Error

429Previše zahtjeva (`api.rate_limited`), kvota organizacije za minutu, dan ili mjesec je potrošena (`api.quota_exceeded`; `error.details` sadrži `quota`, `limit` i `reset_at`), dosegnuto je ograničenje organizacije ili je usluga odgovora zauzeta (`answers.engine_busy`). Pričekajte vrijeme navedeno u zaglavlju `Retry-After`.

Zaglavlja odgovora

  • Retry-After

    Broj sekundi koje treba pričekati prije ponovnog pokušaja zahtjeva.

  • RateLimit-Policy

    Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.

  • RateLimit

    Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).

  • X-RateLimit-Remaining

    Preostali zahtjevi u okviru najstrožeg ograničenja.

  • X-RateLimit-Reset

    Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: Error

Kodovi pogrešaka

Kodovi koje ova operacija može vratiti u error.code, uz opće kodove svakog zahtjeva.

Ograničenja učestalosti

Odgovori sadrže zaglavlja RateLimit i RateLimit-Policy te ranija zaglavlja X-RateLimit-Limit, X-RateLimit-Remaining i X-RateLimit-Reset. Odgovor 429 sadrži zaglavlje Retry-After u sekundama: pričekajte i pokušajte ponovno.

← groups · Referenca API-ja