Returns every domain on your account as a list envelope — object: "list" with the domains in data, ordered newest first.
Returns every domain on your account as a list envelope — object: "list" with the domains in data, ordered newest first. This collection is not paginated: pagination.nextCursor is always null and pagination.hasMore is always false, so one call returns all of them. Each entry carries the domain's status (pending or verified), its verifiedAt timestamp, a region, and a records array of the DNS records for that domain. The included dairo.app domain always appears as a read-only entry with type: "system" and status: "verified" even though you do not own it. Requires the domains:read scope.
Scope: domains:read. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Response
200 Success. Body: application/json, DomainListResponse.
| Field | Type | Required | Description |
|---|---|---|---|
object | "list" | yes | |
data | array of Domain | yes | |
pagination | Pagination | yes |
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
422 | The request is well-formed but a field failed validation (validation_failed). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |
Delete a budget for a scope
Permanently removes the budget for the {scope} path segment — account, or a key/agent budget's scopeId — and returns 204 No Content with an empty body.
Create a domain and its DNS records
Registers a domain you own for authenticated sending and inbound receiving, and returns the created domain object with the records array to publish in DNS.