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 accessAccount

Accept a pending org invite (session only)

Creates the membership for the invite addressed to the session's email in the given org, then consumes the invite. Returns the org id and the role granted. This is the only way an invite becomes a membership: the invitee must be authenticated with the invited email and act explicitly.

Required permission

Requires the self.update permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl account invite accept
POST
/v1/me/invites/{orgId}/accept

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

orgId*string

Response Body

Joined the organization

application/json
  1. response
organizationId*string
role*string
Example Request
curl -X POST 'https://api.openrelay.inc/v1/me/invites/string/accept'
Example Response
{  "organizationId": "string",  "role": "string"}

List pending invites to the signed-in user GET

Returns the unexpired pending invites whose invited email matches the session's email, with each organization's name, the role offered and the inviter's email. Requires a dashboard session token; API keys are organization keys and cannot hold or accept invites.

Decline a pending org invite (session only) POST

Deletes the pending invite to the given organization addressed to the session's email, without joining. Returns 204 whether or not an invite existed.