Organizations

List an org's members

Changed on

Returns every member of the organization with their user id and role, plus the email, full name and avatar from their profile and their invite and join times.

Requires the member.read permission. See Permissions for the roles and API key permissions that include it.

get/v1/orgs/{orgId}/members

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/orgs/{orgId}/members
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Response

Members

avatarUrlstring
emailstring
fullNamestring
invitedAtstring
joinedAtstring
rolestring required
roleNamestring

The role's display name (permissions enabled only).

status'active' | 'invited'

Set only on the addOrgMember response, where it is "invited": the invite is recorded and emailed, and the user becomes a member only after accepting it. Listed and updated members omit it, and "active" is not returned.

userIdstring required

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 12b2fcbcc298Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status