Skip to content

Get an organization

GET
/api/organizations/{id}

Returns a single organization by ID. The authenticated user must be a member of the organization (VIEW). Includes the name, plan, trial end date, scalecommerce flag, external customer number, and timestamps.

Authorizations

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext).

Type
API Key (header: X-API-TOKEN)
or
JWT

JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer .

Type
HTTP (bearer)

Parameters

Path Parameters

id*

organization identifier

Type
string
Required

Responses

organization resource

JSON
{
  
"@context": "string",
  
"@id": "string",
  
"@type": "string",
  
"id": 42,
  
"name": "Acme GmbH",
  
"plan": "FREE",
  
"trialEndsAt": "2026-07-31T12:00:00+00:00",
  
"scalecommerce": false,
  
"require2fa": false,
  
"createdAt": "2026-07-01T09:30:00+00:00",
  
"updatedAt": "2026-07-01T09:30:00+00:00",
  
"externalCustomerId": "CUST-000123"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI