Organizations

Get an organization

Changed on

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

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

get/v1/orgs/{orgId}

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/orgs/{orgId}
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Response

The organization

accountStatusstring

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.

billingAddressLine1string
billingAddressLine2string
billingCitystring
billingCountrystring

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

billingEmailstring required
billingNamestring

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

billingPostalCodestring
createdAtstring
idstring required
isProviderboolean
namestring required
planstring required
shortIdstring required
slugstring required
taxCountrystring

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

taxIdstring

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

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 12b2fcbcc298Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status