Skip to content

List an organization's domains​

GET
/api/organizations/{organizationId}/domains

Returns all managed DNS domains belonging to the given organization. Shared domains are excluded from this list. Pagination is disabled, so the full set is returned in one response.

Authorizations​

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext). A token created with readOnly may only perform safe requests (GET, HEAD, OPTIONS); write requests are rejected on every endpoint.

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

organizationId*

Organization identifier

Type
string
Required

Responses​

domain collection

JSON
{
  
"totalItems": 0,
  
"search": {
  
  
"@type": "string",
  
  
"template": "string",
  
  
"variableRepresentation": "string",
  
  
"mapping": [
  
  
  
{
  
  
  
  
"@type": "string",
  
  
  
  
"variable": "string",
  
  
  
  
"property": "string",
  
  
  
  
"required": true
  
  
  
}
  
  
]
  
},
  
"member": [
  
  
{
  
  
  
"@context": "string",
  
  
  
"@id": "string",
  
  
  
"@type": "string",
  
  
  
"id": "0193b6c2-8f1a-7c3d-9e2b-1a2b3c4d5e6f",
  
  
  
"name": "example.com",
  
  
  
"shared": false,
  
  
  
"dnsEnabled": true,
  
  
  
"dnsStatus": "active",
  
  
  
"dnsRecordCount": 12,
  
  
  
"createdAt": "2026-01-15T09:30:00+00:00",
  
  
  
"updatedAt": "2026-01-16T12:00:00+00:00"
  
  
}
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI