Sign in

v4

latestOpenAPI 3.0.22026-08-02109239415.7 KB
manage

Retrieve members of a specific organization

Returns both active members and pending invites for the organization. A pending invite is identified by a non-null invite_status (e.g. PENDING); active members have a null invite_status.

get/manage/api/organization/members

Query parameters

organization_idstring required

Base64 encoded organization ID to retrieve members for

Response

Organization members retrieved successfully

Example response

{
  "members": [
    {
      "invite_id": "invite_id",
      "display_handle": "john_doe",
      "email_address": "john.doe@example.com",
      "role": "OWNER",
      "full_name": "full_name",
      "invite_expiry_time": "2000-01-23T04:56:07+00:00",
      "avatar_url": "https://example.com/avatars/user123.jpg",
      "user_id": "dXNlcl8xMjM",
      "invite_status": "PENDING"
    },
    {
      "invite_id": "invite_id",
      "display_handle": "john_doe",
      "email_address": "john.doe@example.com",
      "role": "OWNER",
      "full_name": "full_name",
      "invite_expiry_time": "2000-01-23T04:56:07+00:00",
      "avatar_url": "https://example.com/avatars/user123.jpg",
      "user_id": "dXNlcl8xMjM",
      "invite_status": "PENDING"
    }
  ]
}