Skip to content

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

limitinteger
Domains per page, 1 to 1000. Default 1000. Default 1000. 1 to 1000.
cursorstring
The nextCursor value from the previous page.
includestring
Extra fields, comma-separated. hostingConnection is the only one.
namestring
Exact domain name, for example example.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

GET /api/v2/domains
curl "https://cloud.hostup.se/api/v2/domains" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 One page of domains, sorted by name.

Response 200
{
"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 object
idstring
namestring
The domain name. Internationalised names are in Unicode form.
serviceStatusstring
One of active, suspended, terminated, pending, cancelled, expired, fraud, transferred_out, unknown.
actionRequiredboolean
True when you must act before the domain can be processed further. Old registration failures stop counting once the domain is no longer pending registration. GET /api/v2/domains/{id}/lifecycle gives the reason and the way to fix it.
awaitingPaymentboolean or null
True when the registration or transfer order of this pending domain has an unpaid invoice. False for a domain that is not pending. Also false when no unpaid order was found. Null when the payment check failed or took too long. Null does not mean paid. No extra order or invoice request is needed.
orderIdstring
The order that created the domain. Left out when it is not known.
lifecycleobject
typestring
The kind of lifecycle. Common values are standard, registration, transfer and renewal.
autoRenewEnabledboolean or null
Whether the domain renews automatically. Always false while the domain is pending. Null when not known.
registrarLockEnabledboolean or null
transferInProgressboolean
True while a transfer to Hostup is in progress. Follow it on GET /api/v2/domains/{id}/lifecycle.
billingobject
amountnumber
Renewal price for one billing period, in currencyCode.
currencyCodestring
billingCyclestring or null
The billing cycle for a period of 1 to 3 years. Null for 4 to 9 years. Read periodYears then. One of annually, biennially, triennially.
periodYearsinteger or null
1 to 9.
initialAmountnumber
Price of the first period, when it differs from the renewal price.
createdAtstring or null
expiresAtstring or null
nextDueAtstring or null
When the next renewal payment is due.
tagsarray of string
pinnedboolean
contactDetailsVerificationnull
The current contact-details warning for this domain. Null when no update is needed. Otherwise an object with reason (text to show), deadlineAt, renewalBlocked, serviceInterruptionRisk and actions.canUpdateContacts.
hostingConnectionobject
typestring
One of standalone, hosting, wordpress.
hostingAccountIdstring or null
hostingAccountNamestring or null
hostingAccountDomainstring or null
sslobject or null
hasMoreboolean
nextCursorstring or null

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400Bad paging. code is invalid_pagination_limit (limit is not between 1 and 1000) or invalid_cursor (cursor is not a valid nextCursor value).
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.
503service_unavailable: the domains could not be loaded. Try again.