Documentation menu
Organization User Groups

List members of a user group

GET /api/v1/organizations/{organizationIdOrSlug}/user-groups/{userGroupId}/members

Parameters

path

NameTypeRequiredDescription
organizationIdOrSlugone of 2 typesrequiredIdentifies the organization by its stable identifier or slug. For a session, an identifier-shaped value is resolved as a stable identifier. Applies to List members of a user group.
userGroupIdstringrequiredIdentifies the Organization or Project user group being addressed. Applies to List members of a user group.

query

NameTypeRequiredDescription
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List members of a user group.
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List members of a user group.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required); pagination: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)