Skip to content

Read contacts for several domains

POST /api/v2/domains/bulk/contacts/read

Read the registrant contact of several domains in one call. The response is newline-delimited JSON (application/x-ndjson) with one line per domain, in the order you sent the IDs. Each line has domainId, domainName, contact and error.

The whole request is checked before the stream starts. An invalid ID or a domain that is not in your account returns Problem Details instead of a stream. Once the stream has started, a domain whose contact cannot be loaded gets a line with contact: null and an error text. contact: null with error: null means there is no contact to read, for example after the domain was transferred away.

Authentication: An API key with the scope read:domains. About keys and scopes

Request

Body

domainIdsarray of stringrequired
Domain IDs (dom_…) to read. At least one.

Example

POST /api/v2/domains/bulk/contacts/read
curl -X POST "https://cloud.hostup.se/api/v2/domains/bulk/contacts/read" \
-H "Authorization: Bearer $HOSTUP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"domainIds": [
"dom_01hxa3b4c5d6e7f8g9h0j1k2m3",
"dom_01hxa3b4c5d6e7f8g9h0j1k2m4"
]
}'

Responses

200 NDJSON stream with one JSON object per domain.

Content type: application/x-ndjson

Errors

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

400Invalid request. The response body is an RFC 7807 Problem Details document.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404Not found. The resource does not exist or is not owned by the caller; code is domain_not_found.
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.