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

Create an organization (caller becomes owner)

Creates an organization owned by the caller and returns its id and the owner role. A custom slug must be unique; one account owns at most five organizations. 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.

Command line

The orl CLI wraps this endpoint:

orl organizations create --name <name>
POST
/v1/orgs

Authorization

apiKey
headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body
name*string
slug?string
billingEmail?string
deviceFingerprint?string

Optional Fingerprint visitor id (see DeviceSignals). Recorded and clustered; never gates org creation.

Lengthlength <= 128
deviceEventId?string

Optional Fingerprint event id (see DeviceSignals).

Lengthlength <= 128

Response Body

Created (caller is owner)

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

Record the caller's signed-in browser device POST

Records the Fingerprint visitor id of the browser a member is signed in from against an existing organization, and checks the device like a sign-in. It covers organizations created automatically at first sign-in, whose creation carries no device. Any member of the org may call it. Under an enforcing device policy, a device that fails the check places the org on a verification hold. It always returns 204 once authorized, including when the body is empty: a browser that blocked the agent must not see an error.

Get an organization GET

Returns the organization's ids, name, slug, plan, billing email, tax id, invoice address and account status (active, pending, restricted, suspended or banned).