Pereiti prie turinio
Sursa Developers

GET/v1/groups

Gauti organizacijos grupių sąrašą

list_groups

Be kind grąžina įprastas grupes, „All members“ (visi nariai) ir vaidmenų grupes. Asmeninės grupės (single_user) grąžinamos tik aiškiai nurodžius kind=single_user. Grupių all_members, role ir single_user narystė, kaip ir jų members_count, apskaičiuojama pagal organizacijos naudotojus.

Autentifikavimas

Siųskite API raktą antraštėje Authorization: Authorization: Bearer <raktas>.

Užklausos parametrai

  • kindGroupKind
  • limitinteger

    Puslapio dydis. Be limit ir cursor grąžinamas visas sąrašas; su juo – ne daugiau kaip limit elementų, o kitas puslapis nurodomas antraštėse Link (rel="next") ir X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Kito puslapio žymeklis iš X-Next-Cursor arba iš ankstesnio atsako su tais pačiais filtrais lauko next_cursor; jame užkoduotas ir puslapio dydis. Kartu su offset: 422 validation.failed; kito sąrašo, kitų filtrų ar sugadintas žymeklis: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Tik objektai, kurių updated_at ne ankstesnis už šį momentą (RFC 3339 su laiko juostos poslinkiu); skirta sinchronizacijai. Su juo sąrašas rikiuojamas pagal updated_at didėjančia tvarka, paskui pagal id, o žymeklis tęsia ta pačia tvarka. Ištrinti objektai sąraše nepateikiami: apie ištrynimus pranešama įvykiais.

    length ≤ 512

Atsakai

200Sėkmingas atsakas

Atsako antraštės

  • Link

    Kito puslapio adresas, <…>; rel="next". Jei antraštės nėra, tai paskutinis puslapis.

  • X-Next-Cursor

    Kito puslapio žymeklis parametrui cursor. Jei antraštės nėra, tai paskutinis puslapis.

  • RateLimit-Policy

    Galiojantys limitai IETF juodraščio draft-ietf-httpapi-ratelimit-headers formatu: kableliais atskirti elementai "<name>";q=<quota>;w=<window in seconds>. key – API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai tai user, be prisijungimo duomenų – ip); minute, day ir month – organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.

  • RateLimit

    Kiek liko kiekvieno RateLimit-Policy limito: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Griežčiausio RateLimit-Policy įrašo (kuriame liko mažiausiai užklausų) limitas.

  • X-RateLimit-Remaining

    Likusių užklausų skaičius pagal griežčiausią limitą.

  • X-RateLimit-Reset

    Sekundės iki griežčiausio limito atsistatymo.

application/json

Objektas: GroupList

array of Group
  • idintegerprivalomas
  • org_idintegerprivalomas
  • keystringprivalomas

    Pastovus raktas: all, role:<role>, user:<id> arba įprastos grupės raktas. Sąsaja integruotų grupių pavadinimus verčia pagal raktą.

  • titlestringprivalomas
  • kindGroupKindprivalomas
  • user_idinteger | nullprivalomas

    Tik asmeninėms grupėms.

  • role_keyRole | nullprivalomas

    Tik vaidmenų grupėms.

  • managed_byGroupManagedByprivalomas
  • members_countintegerprivalomas

    Aktyvių narių skaičius. Deaktyvuoti naudotojai nėra grupių nariai.

  • disabledbooleanprivalomas

    Deaktyvuoto naudotojo asmeninė grupė: jos suteikimai išsaugomi, bet negalioja, kol naudotojas neaktyvus. Visoms kitoms grupėms – false.

  • created_atstring (date-time)privalomas
  • updated_atstring (date-time)privalomas
401Prisijungimo duomenys neišsiųsti (nei sesijos slapukas, nei API raktas) arba raktas nerastas.

Atsako antraštės

  • RateLimit-Policy

    Galiojantys limitai IETF juodraščio draft-ietf-httpapi-ratelimit-headers formatu: kableliais atskirti elementai "<name>";q=<quota>;w=<window in seconds>. key – API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai tai user, be prisijungimo duomenų – ip); minute, day ir month – organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.

  • RateLimit

    Kiek liko kiekvieno RateLimit-Policy limito: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Griežčiausio RateLimit-Policy įrašo (kuriame liko mažiausiai užklausų) limitas.

  • X-RateLimit-Remaining

    Likusių užklausų skaičius pagal griežčiausią limitą.

  • X-RateLimit-Reset

    Sekundės iki griežčiausio limito atsistatymo.

application/json

Objektas: Error

422Validavimo klaida: turinys ar parametrai neatitinka schemos (`detail` – validavimo klaidų sąrašas) arba parametro reikšmė nepatenka į leistiną intervalą (`detail` – pranešimas).

Atsako antraštės

  • RateLimit-Policy

    Galiojantys limitai IETF juodraščio draft-ietf-httpapi-ratelimit-headers formatu: kableliais atskirti elementai "<name>";q=<quota>;w=<window in seconds>. key – API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai tai user, be prisijungimo duomenų – ip); minute, day ir month – organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.

  • RateLimit

    Kiek liko kiekvieno RateLimit-Policy limito: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Griežčiausio RateLimit-Policy įrašo (kuriame liko mažiausiai užklausų) limitas.

  • X-RateLimit-Remaining

    Likusių užklausų skaičius pagal griežčiausią limitą.

  • X-RateLimit-Reset

    Sekundės iki griežčiausio limito atsistatymo.

application/json

Objektas: Error

429Per daug užklausų (`api.rate_limited`), išnaudota organizacijos minutės, dienos ar mėnesio kvota (`api.quota_exceeded`; `error.details` pateikia `quota`, `limit` ir `reset_at`), pasiektas organizacijos limitas arba atsakymų paslauga užimta (`answers.engine_busy`). Palaukite tiek, kiek nurodyta antraštėje `Retry-After`.

Atsako antraštės

  • Retry-After

    Kiek sekundžių palaukti prieš kartojant užklausą.

  • RateLimit-Policy

    Galiojantys limitai IETF juodraščio draft-ietf-httpapi-ratelimit-headers formatu: kableliais atskirti elementai "<name>";q=<quota>;w=<window in seconds>. key – API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai tai user, be prisijungimo duomenų – ip); minute, day ir month – organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.

  • RateLimit

    Kiek liko kiekvieno RateLimit-Policy limito: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Griežčiausio RateLimit-Policy įrašo (kuriame liko mažiausiai užklausų) limitas.

  • X-RateLimit-Remaining

    Likusių užklausų skaičius pagal griežčiausią limitą.

  • X-RateLimit-Reset

    Sekundės iki griežčiausio limito atsistatymo.

application/json

Objektas: Error

Klaidų kodai

Kodai, kuriuos ši operacija gali grąžinti lauke error.code, be bendrųjų kodų, galimų bet kuriai užklausai.

Užklausų dažnio limitai

Atsakuose yra antraštės RateLimit ir RateLimit-Policy bei ankstesnės X-RateLimit-Limit, X-RateLimit-Remaining ir X-RateLimit-Reset. Atsake 429 yra antraštė Retry-After sekundėmis: palaukite ir pakartokite užklausą.

← groups · API žinynas