Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceAccount and accessOrganizations

List an org's members

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.

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl organizations member list
GET
/v1/orgs/{orgId}/members

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

orgId*string

Response Body

Members

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string/members'
Example Response
[  {    "userId": "string",    "role": "string",    "roleName": "string",    "email": "string",    "fullName": "string",    "avatarUrl": "string",    "invitedAt": "string",    "joinedAt": "string",    "status": "active"  }]

Overview

Organizations and their members: create, update or soft-delete an org, invite, remove or re-role members, or leave one. Most resources are scoped to an org.

List an org's pending invites (owner/admin) GET

Returns the organization's invites not yet accepted, declined or revoked, each with the email, role, inviter's user id and expiry. Expired invites are still listed.