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 pending invites (owner/admin)

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.

Required permission

Checked against the member.invite permission for the resource it acts on. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl organizations invite list
GET
/v1/orgs/{orgId}/invites

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

orgId*string

Response Body

Pending invites

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string/invites'
Example Response
[  {    "email": "string",    "role": "string",    "invitedBy": "string",    "invitedAt": "string",    "expiresAt": "string"  }]

List an org's members GET

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.

Revoke a pending invite (owner/admin) DELETE

Deletes the pending invite for an email address so it can no longer be accepted. Returns 204, including when no invite exists; the email match ignores case.