Skip to content

List organizations

GET
/api/organizations

Returns the organizations the authenticated user is a member of, ordered by name ascending. Use the q parameter to search by name (partial match).

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

Query Parameters

page

The collection page number

Type
integer
Default
1
itemsPerPage

The number of items per page

Type
integer
Default
30
Minimum
0
Maximum
100
q

Search organizations by name (partial match)

Type
string
order[name]

Sort by organization name (asc or desc).

Type
string
Valid values
"asc""desc""ASC""DESC"
order[id]

Sort by organization ID (asc or desc).

Type
string
Valid values
"asc""desc""ASC""DESC"
order[createdAt]

Sort by creation date (asc or desc).

Type
string
Valid values
"asc""desc""ASC""DESC"
order[plan]

Sort by subscription plan (asc or desc).

Type
string
Valid values
"asc""desc""ASC""DESC"

Responses

organization collection

JSON
{
  
"totalItems": 0,
  
"search": {
  
  
"@type": "string",
  
  
"template": "string",
  
  
"variableRepresentation": "string",
  
  
"mapping": [
  
  
  
{
  
  
  
  
"@type": "string",
  
  
  
  
"variable": "string",
  
  
  
  
"property": "string",
  
  
  
  
"required": true
  
  
  
}
  
  
]
  
},
  
"view": {
  
  
"@id": "string",
  
  
"@type": "string",
  
  
"first": "string",
  
  
"last": "string",
  
  
"previous": "string",
  
  
"next": "string"
  
},
  
"member": [
  
  
{
  
  
  
"@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