Skip to main content
GET
Retrieve a domain

Authorizations

Authorization
string
header
required

API key issued in the dashboard. Server-side only: never ship it to a browser, and never pass it as a query parameter.

Path Parameters

id
string
required
Example:

"dom_4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e"

Response

id
string
required
Example:

"dom_4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e"

object
enum<string>
required
Available options:
domain
hostname
string
required
Example:

"links.example.com"

status
enum<string>
required

Verification state. Links on a domain start working once it is active.

Available options:
pending,
ssl_pending,
active,
failed
expires_at
string<date-time> | null
required

Verification deadline. Meaningful while the domain is pending; null otherwise.

Example:

"2026-09-04T10:00:00Z"

created_at
string<date-time>
required
Example:

"2026-08-21T10:00:00Z"

dns_instructions
object[]
required

Records to add at your DNS provider before verification.