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

Get an organization

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

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl organizations get
GET
/v1/orgs/{orgId}

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

orgId*string

Response Body

The organization

application/json
  1. response
id*string
shortId*string
name*string
slug*string
billingEmail*string
plan*string
isProvider?boolean
createdAt?string
taxId?string

Customer tax identifier stored on the organization (US EIN, EU/UK VAT, SG GST, etc.), shown on the billing settings page. Requires taxCountry.

taxCountry?string

ISO 3166-1 alpha-2 country whose tax scheme taxId belongs to (e.g. US, GB, SG, DE).

billingName?string

Name printed on invoices and credit notes. Empty means the org name is used.

billingAddressLine1?string
billingAddressLine2?string
billingCity?string
billingPostalCode?string
billingCountry?string

ISO 3166-1 alpha-2 country of the billing address.

accountStatus?string

User-facing account state derived from the org's trust & safety risk state. "active" = normal; "pending" = a verification hold: the account can sign in and use the dashboard but cannot be funded, new deploys are paused, existing workloads keep running, and it clears on review (usually under one business day); "restricted" = new deploys paused pending review (existing workloads keep running, funding still allowed); "suspended" = read-only, workloads stopped, pending review; "banned" = disabled. Drives the dashboard account-status banner. Omitted/"active" means no banner.

Example Request
curl -X GET 'https://api.openrelay.inc/v1/orgs/string'
Example Response
{  "id": "string",  "shortId": "string",  "name": "string",  "slug": "string",  "billingEmail": "string",  "plan": "string",  "isProvider": true,  "createdAt": "string",  "taxId": "string",  "taxCountry": "string",  "billingName": "string",  "billingAddressLine1": "string",  "billingAddressLine2": "string",  "billingCity": "string",  "billingPostalCode": "string",  "billingCountry": "string",  "accountStatus": "string"}

Create an organization (caller becomes owner) POST

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.

Update an organization (owner/admin) PATCH

Changes the organization's name, billing email, tax id and country, and invoice address, and returns it. An empty string clears the tax and address fields.