Пређите на садржај
Sursa Developers

GET/v1/groups

Списак група организације

list_groups

Без kind враћа обичне групе, „All members“ и групе улога. Личне групе (single_user) враћају се само уз експлицитно kind=single_user. Чланство у групама all_members, role и single_user израчунава се на основу корисника организације, као и њихов members_count.

Аутентификација

Пошаљите API кључ у заглављу Authorization: Authorization: Bearer <кључ>.

Параметри упита

  • kindGroupKind
  • limitinteger

    Величина странице. Без limit и cursor враћа се цела листа; са њим – највише limit ставки, а следећа страница се наводи у заглављима Link (rel="next") и X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Курсор следеће странице из X-Next-Cursor или next_cursor претходног одговора са истим филтерима; садржи величину странице. Заједно са offset: 422 validation.failed; курсор друге листе, са другим филтерима или неисправан курсор: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Само објекти са updated_at у овом тренутку или касније (RFC 3339 са померајем), за синхронизацију. Уз њега се листа сортира по updated_at растуће, затим по id, а курсор наставља тим редоследом. Обрисани објекти се не наводе: брисања стижу као догађаји.

    length ≤ 512

Одговори

200Успешан одговор

Заглавља одговора

  • Link

    Адреса следеће странице, <…>; rel="next". Ако заглавља нема, ово је последња страница.

  • X-Next-Cursor

    Курсор следеће странице за параметар cursor. Ако заглавља нема, ово је последња страница.

  • RateLimit-Policy

    Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.

  • RateLimit

    Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).

  • X-RateLimit-Remaining

    Број преосталих захтева по најстрожем ограничењу.

  • X-RateLimit-Reset

    Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: GroupList

array of Group
  • idintegerобавезно
  • org_idintegerобавезно
  • keystringобавезно

    Стабилан кључ: all, role:<role>, user:<id> или кључ обичне групе. Интерфејс преводи уграђене групе по кључу.

  • titlestringобавезно
  • kindGroupKindобавезно
  • user_idinteger | nullобавезно

    Само за личне групе.

  • role_keyRole | nullобавезно

    Само за групе улога.

  • managed_byGroupManagedByобавезно
  • members_countintegerобавезно

    Број активних чланова. Деактивирани корисници нису чланови група.

  • disabledbooleanобавезно

    Лична група деактивираног корисника: њене доделе се чувају, али немају дејство док је корисник неактиван. false за све остале групе.

  • created_atstring (date-time)обавезно
  • updated_atstring (date-time)обавезно
401Акредитиви нису послати (ни колачић сесије ни API кључ) или кључ није пронађен.

Заглавља одговора

  • RateLimit-Policy

    Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.

  • RateLimit

    Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).

  • X-RateLimit-Remaining

    Број преосталих захтева по најстрожем ограничењу.

  • X-RateLimit-Reset

    Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error

422Грешка валидације: тело или параметри не одговарају шеми (`detail` је листа грешака валидације) или је вредност параметра ван дозвољеног распона (`detail` је порука).

Заглавља одговора

  • RateLimit-Policy

    Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.

  • RateLimit

    Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).

  • X-RateLimit-Remaining

    Број преосталих захтева по најстрожем ограничењу.

  • X-RateLimit-Reset

    Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error

429Превише захтева (`api.rate_limited`), квота организације за минут, дан или месец је потрошена (`api.quota_exceeded`; `error.details` садржи `quota`, `limit` и `reset_at`), достигнуто је ограничење организације или је сервис за одговоре заузет (`answers.engine_busy`). Сачекајте време наведено у заглављу `Retry-After`.

Заглавља одговора

  • Retry-After

    Број секунди које треба сачекати пре поновног покушаја захтева.

  • RateLimit-Policy

    Ограничења која важе, у формату IETF нацрта draft-ietf-httpapi-ratelimit-headers: ставке раздвојене зарезима "<name>";q=<quota>;w=<window in seconds>. key је учесталост захтева API кључа (квота је налет, прозор је време за потпуно обнављање; за сесију то је user, без акредитива – ip); minute, day и month су квоте организације за календарски минут, дан и месец по UTC.

  • RateLimit

    Колико је преостало од сваког ограничења из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ограничење најстроже ставке у RateLimit-Policy (оне са најмање преосталих захтева).

  • X-RateLimit-Remaining

    Број преосталих захтева по најстрожем ограничењу.

  • X-RateLimit-Reset

    Број секунди до ресетовања најстрожег ограничења.

application/json

Објекат: Error

Кодови грешака

Кодови које ова операција може да врати у error.code, поред општих кодова сваког захтева.

Ограничења учесталости

Одговори садрже заглавља RateLimit и RateLimit-Policy, као и старија X-RateLimit-Limit, X-RateLimit-Remaining и X-RateLimit-Reset. Одговор 429 садржи заглавље Retry-After у секундама: сачекајте и поновите захтев.

← groups · API референца