Hoppa till innehållet
Sursa Developers

GET/v1/groups

Lista organisationens grupper

list_groups

Utan kind returneras vanliga grupper, ”All members” (alla medlemmar) och rollgrupper. Personliga grupper (single_user) returneras bara med ett uttryckligt kind=single_user. Medlemskapet i grupperna all_members, role och single_user beräknas från organisationens användare, och det gör även deras members_count.

Autentisering

Skicka en API-nyckel i huvudet Authorization: Authorization: Bearer <nyckel>.

Frågeparametrar

  • kindGroupKind
  • limitinteger

    Sidstorlek. Utan limit och cursor returneras hela listan; med den returneras högst limit element, och nästa sida anges i huvudena Link (rel="next") och X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Markör för nästa sida från X-Next-Cursor eller next_cursor i föregående svar med samma filter; den bär med sig sidstorleken. Tillsammans med offset: 422 validation.failed; en markör från en annan lista, med andra filter eller en felformaterad markör: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Bara objekt med updated_at vid eller efter den här tidpunkten (RFC 3339 med tidszonsförskjutning), för synkning. Med den sorteras listan efter updated_at i stigande ordning och sedan efter id, och markören fortsätter i den ordningen. Borttagna objekt listas inte: borttagningar kommer som händelser.

    length ≤ 512

Svar

200Lyckat svar

Svarshuvuden

  • Link

    Adressen till nästa sida, <…>; rel="next". Saknas huvudet är det här den sista sidan.

  • X-Next-Cursor

    Markör för nästa sida för parametern cursor. Saknas huvudet är det här den sista sidan.

  • RateLimit-Policy

    Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.

  • RateLimit

    Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).

  • X-RateLimit-Remaining

    Återstående anrop inom den striktaste gränsen.

  • X-RateLimit-Reset

    Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: GroupList

array of Group
  • idintegerobligatorisk
  • org_idintegerobligatorisk
  • keystringobligatorisk

    Stabil nyckel: all, role:<role>, user:<id> eller nyckeln för en vanlig grupp. Gränssnittet översätter inbyggda grupper efter nyckel.

  • titlestringobligatorisk
  • kindGroupKindobligatorisk
  • user_idinteger | nullobligatorisk

    Bara personliga grupper.

  • role_keyRole | nullobligatorisk

    Bara rollgrupper.

  • managed_byGroupManagedByobligatorisk
  • members_countintegerobligatorisk

    Antal aktiva medlemmar. Inaktiverade användare är inte medlemmar i grupper.

  • disabledbooleanobligatorisk

    En inaktiverad användares personliga grupp: dess tilldelningar behålls men har ingen verkan medan användaren är inaktiv. false för alla andra grupper.

  • created_atstring (date-time)obligatorisk
  • updated_atstring (date-time)obligatorisk
401Inga autentiseringsuppgifter skickades (varken en sessionscookie eller en API-nyckel), eller så hittades inte nyckeln.

Svarshuvuden

  • RateLimit-Policy

    Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.

  • RateLimit

    Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).

  • X-RateLimit-Remaining

    Återstående anrop inom den striktaste gränsen.

  • X-RateLimit-Reset

    Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

422Valideringsfel: brödtexten eller parametrarna stämmer inte med schemat (`detail` är en lista med valideringsfel), eller så ligger ett parametervärde utanför det tillåtna intervallet (`detail` är ett meddelande).

Svarshuvuden

  • RateLimit-Policy

    Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.

  • RateLimit

    Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).

  • X-RateLimit-Remaining

    Återstående anrop inom den striktaste gränsen.

  • X-RateLimit-Reset

    Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

429För många anrop (`api.rate_limited`), organisationens kvot för minuten, dygnet eller månaden är förbrukad (`api.quota_exceeded`; `error.details` innehåller `quota`, `limit` och `reset_at`), organisationens gräns är nådd eller svarstjänsten är upptagen (`answers.engine_busy`). Vänta den tid som anges i huvudet `Retry-After`.

Svarshuvuden

  • Retry-After

    Antal sekunder att vänta innan du skickar anropet igen.

  • RateLimit-Policy

    Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.

  • RateLimit

    Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).

  • X-RateLimit-Remaining

    Återstående anrop inom den striktaste gränsen.

  • X-RateLimit-Reset

    Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

Felkoder

Koder som den här slutpunkten kan returnera i error.code, utöver de allmänna koderna för alla anrop.

Hastighetsbegränsningar

Svaren innehåller huvudena RateLimit och RateLimit-Policy samt de tidigare X-RateLimit-Limit, X-RateLimit-Remaining och X-RateLimit-Reset. Ett 429-svar har Retry-After i sekunder: vänta och försök igen.

← groups · API-referens