Skip to main content

List members

GET/api/members
AdministratorRead-only

Read more: When someone leavesSource: OrganizationMemberApiController#members(opens in new tab)

Response​

Success: 200

An array of MemberView, each with:

FieldTypeRequiredNotes
idstring (uuid)Optional
emailstringOptional
displayNamestringOptional
roleenum AppUserRoleOptionalADMINMEMBER
createdAtstring (date-time)Optional

Errors​

StatusCodeApplies to
400validation_faileda field is missing or out of rangeAny endpoint
400invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUIDAny endpoint
401authentication_requiredno sessionAny endpoint
403access_deniedan administrator endpoint, or a missing or stale CSRF tokenAny endpoint
404not_foundno such addressAny endpoint
405method_not_allowedthe address does not take that methodAny endpoint
415unsupported_media_typethe address does not read a body of that typeAny endpoint
500internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind itAny endpoint
400output_language_invalidAccount area
400ui_locale_invalidAccount area
400invitation_invalidAccount area
400organization_slug_invalidAccount area
404invitation_not_foundAccount area
404member_not_foundAccount area
409email_already_registeredAccount area
409invitation_already_pendingAccount area
409invitation_email_unavailableAccount area
409organization_slug_takenAccount area
409member_last_administratorAccount area

Request

bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
curl "http://localhost:8080/api/members" \
-b cookies.txt -c cookies.txt

Response

200

Example

[
  {
    "id": "<uuid>",
    "email": "<string>",
    "displayName": "<string>",
    "role": "ADMIN",
    "createdAt": "<date-time>"
  }
]