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

Create your profile and first org (idempotent)

Creates the signed-in user's profile and a first organization they own (named orgName, or My Organization). A user already set up gets their default org back. Requires a signed-in dashboard session token; API keys cannot call this endpoint.

Required permission

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

POST
/v1/onboarding/bootstrap

Authorization

apiKey
headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body
orgName?string

Response Body

Bootstrapped (or already existed)

application/json
  1. response
organizationId*string
role*string
Example Request
curl -X POST 'https://api.openrelay.inc/v1/onboarding/bootstrap' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "organizationId": "string",  "role": "string"}

Overview

The signed-in user: profile, memberships, and first-time onboarding, plus the invites addressed to you and the identity and org each request acts in.

Current user profile and org memberships GET

Returns the signed-in user's profile and organization memberships. Requires a dashboard session token; API keys cannot call this endpoint.