List organization members

GET /organizations/{organization_id}/members

Fetch users belonging to the selected organization. Currently unavailable in self-hosted ECE.

Path parameters

Responses

  • Organization members fetched successfully

    Hide response attribute Show response attribute object
    • members array[object] Required

      The list of organization memberships

      Hide members attributes Show members attributes object
      • organization_id string Required

        The organization's identifier

      • user_id string Required

        The users's identifier

      • name string

        The user's full name

      • email string

        The user's email address

      • member_since string(date-time) Required

        The date and time the user was added to the organization

  • Organization not found. (code: organization.not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is organization.not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

GET /organizations/{organization_id}/members
curl \
 -X GET https://{{hostname}}/api/v1/organizations/{organization_id}/members
Response examples (200)
{
  "members": [
    {
      "organization_id": "string",
      "user_id": "string",
      "name": "string",
      "email": "string",
      "member_since": "2024-05-04T09:42:00+00:00"
    }
  ]
}
Response examples (404)
# Headers
x-cloud-error-codes: organization.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}