List domains
GET /api/v2/domains
Lists the domains on the account with status, lifecycle, billing, dates, tags, pin state and any contact-details warning. Cancelled, terminated and transferred-out domains are left out. Add name=example.com to get only that domain and its public dom_... ID. Use that ID, not the domain name, as {id} on the other domain endpoints.
actionRequired is true when you must act before the domain can continue, for example after a failed registration, transfer or renewal. GET /api/v2/domains/{id}/lifecycle gives the reason and the way forward. awaitingPayment is true while a pending domain’s order has an unpaid invoice. Add include=hostingConnection to get each domain’s web hosting connection. Nameservers, transfer details and per-domain action gates are on GET /api/v2/domains/{id}.
Authentication: An API key with the scope read:domains. About keys and scopes
Request
Query parameters
limitinteger1000. 1 to 1000.cursorstringnextCursor value from the previous page.includestringhostingConnection is the only one.namestringexample.com. Unicode and punycode forms both match. Returns only that domain, with its public dom_... ID. data is empty when the account has no domain by that name.Example
curl "https://cloud.hostup.se/api/v2/domains" \ -H "Authorization: Bearer $HOSTUP_API_KEY"Responses
200 One page of domains, sorted by name.
{ "data": [ { "id": "dom_01hxa3b4c5d6e7f8g9h0j1k2m3", "name": "example.com", "serviceStatus": "active", "actionRequired": false, "awaitingPayment": false, "lifecycle": { "type": "registration", "autoRenewEnabled": true, "registrarLockEnabled": false, "transferInProgress": false }, "billing": { "amount": 159, "currencyCode": "SEK", "billingCycle": "annually", "periodYears": 1 }, "createdAt": "2025-04-27T09:00:00.000Z", "expiresAt": "2027-04-27T21:59:59.000Z", "nextDueAt": "2027-03-28T00:00:00.000Z", "tags": [ "production" ], "pinned": false, "contactDetailsVerification": null } ], "hasMore": false, "nextCursor": null}Response fields
dataarray of objectidstringnamestringserviceStatusstringactive, suspended, terminated, pending, cancelled, expired, fraud, transferred_out, unknown.actionRequiredbooleanGET /api/v2/domains/{id}/lifecycle gives the reason and the way to fix it.awaitingPaymentboolean or nullorderIdstringlifecycleobjecttypestringstandard, registration, transfer and renewal.autoRenewEnabledboolean or nullregistrarLockEnabledboolean or nulltransferInProgressbooleanGET /api/v2/domains/{id}/lifecycle.billingobjectamountnumbercurrencyCode.currencyCodestringbillingCyclestring or nullperiodYears then. One of annually, biennially, triennially.periodYearsinteger or nullinitialAmountnumbercreatedAtstring or nullexpiresAtstring or nullnextDueAtstring or nulltagsarray of stringpinnedbooleancontactDetailsVerificationnullreason (text to show), deadlineAt, renewalBlocked, serviceInterruptionRisk and actions.canUpdateContacts.hostingConnectionobjecttypestringstandalone, hosting, wordpress.hostingAccountIdstring or nullhostingAccountNamestring or nullhostingAccountDomainstring or nullsslobject or nullhasMorebooleannextCursorstring or nullErrors
Errors are Problem Details with a stable code. Branch on the code, not on the text.
| 400 | Bad paging. code is invalid_pagination_limit (limit is not between 1 and 1000) or invalid_cursor (cursor is not a valid nextCursor value). |
| 401 | Unauthorized. Authentication is required. |
| 403 | Forbidden. The caller lacks a required scope or does not own the resource. |
| 429 | Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers. |
| 500 | Internal error. Retry later or contact support if the issue persists. |
| 503 | service_unavailable: the domains could not be loaded. Try again. |