Przejdź do treści
Sursa Developers

GET/v1/groups

Pobieranie listy grup organizacji

list_groups

Bez kind zwraca zwykłe grupy, „All members” i grupy ról. Grupy osobiste (single_user) są zwracane tylko przy jawnym kind=single_user. Członkostwo w grupach all_members, role i single_user jest wyliczane na podstawie użytkowników organizacji, podobnie jak ich members_count.

Uwierzytelnianie

Wyślij klucz API w nagłówku Authorization: Authorization: Bearer <klucz>.

Parametry zapytania

  • kindGroupKind
  • limitinteger

    Rozmiar strony. Bez limit i cursor zwracana jest cała lista; z tym parametrem – najwyżej limit elementów, a następna strona jest podana w nagłówkach Link (rel="next") i X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Kursor następnej strony z X-Next-Cursor lub next_cursor poprzedniej odpowiedzi z tymi samymi filtrami; zawiera rozmiar strony. Razem z offset: 422 validation.failed; kursor innej listy, innych filtrów lub uszkodzony: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Tylko obiekty z updated_at w tym momencie lub później (RFC 3339 z przesunięciem strefy czasowej), do synchronizacji. Z tym parametrem lista jest sortowana rosnąco według updated_at, a następnie według id, a kursor kontynuuje w tej kolejności. Usunięte obiekty nie są wymieniane: usunięcia przychodzą jako zdarzenia.

    length ≤ 512

Odpowiedzi

200Pomyślna odpowiedź

Nagłówki odpowiedzi

  • Link

    Adres następnej strony, <…>; rel="next". Brak nagłówka oznacza, że to ostatnia strona.

  • X-Next-Cursor

    Kursor następnej strony dla parametru cursor. Brak nagłówka oznacza, że to ostatnia strona.

  • RateLimit-Policy

    Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.

  • RateLimit

    Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).

  • X-RateLimit-Remaining

    Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.

  • X-RateLimit-Reset

    Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: GroupList

array of Group
  • idintegerwymagane
  • org_idintegerwymagane
  • keystringwymagane

    Stały klucz: all, role:<role>, user:<id> lub klucz zwykłej grupy. Interfejs tłumaczy grupy wbudowane według klucza.

  • titlestringwymagane
  • kindGroupKindwymagane
  • user_idinteger | nullwymagane

    Tylko grupy osobiste.

  • role_keyRole | nullwymagane

    Tylko grupy ról.

  • managed_byGroupManagedBywymagane
  • members_countintegerwymagane

    Liczba aktywnych członków. Dezaktywowani użytkownicy nie są członkami grup.

  • disabledbooleanwymagane

    Grupa osobista dezaktywowanego użytkownika: jej przypisania są zachowywane, ale nie działają, dopóki użytkownik jest nieaktywny. false dla wszystkich innych grup.

  • created_atstring (date-time)wymagane
  • updated_atstring (date-time)wymagane
401Nie przesłano danych uwierzytelniających (ani pliku cookie sesji, ani klucza API) lub nie znaleziono klucza.

Nagłówki odpowiedzi

  • RateLimit-Policy

    Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.

  • RateLimit

    Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).

  • X-RateLimit-Remaining

    Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.

  • X-RateLimit-Reset

    Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

422Błąd walidacji: treść lub parametry nie odpowiadają schematowi (`detail` to lista błędów walidacji) albo wartość parametru jest poza zakresem (`detail` zawiera komunikat).

Nagłówki odpowiedzi

  • RateLimit-Policy

    Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.

  • RateLimit

    Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).

  • X-RateLimit-Remaining

    Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.

  • X-RateLimit-Reset

    Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

429Zbyt wiele żądań (`api.rate_limited`), wyczerpano przydział organizacji na minutę, dzień lub miesiąc (`api.quota_exceeded`; `error.details` zawiera `quota`, `limit` i `reset_at`), osiągnięto limit organizacji albo usługa odpowiedzi jest zajęta (`answers.engine_busy`). Odczekaj czas podany w nagłówku `Retry-After`.

Nagłówki odpowiedzi

  • Retry-After

    Liczba sekund oczekiwania przed ponowieniem żądania.

  • RateLimit-Policy

    Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.

  • RateLimit

    Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).

  • X-RateLimit-Remaining

    Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.

  • X-RateLimit-Reset

    Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: Error

Kody błędów

Kody, które ta operacja może zwrócić w error.code, oprócz ogólnych kodów każdego żądania.

Limity częstotliwości

Odpowiedzi zawierają nagłówki RateLimit i RateLimit-Policy oraz starsze X-RateLimit-Limit, X-RateLimit-Remaining i X-RateLimit-Reset. Odpowiedź 429 ma nagłówek Retry-After w sekundach: odczekaj i ponów żądanie.

← groups · Dokumentacja API