GET /api/v1/domains

Endpoint

GET /api/v1/domains

Returns a paginated list of domain registrations associated with the authenticated client's account. This includes domains registered through Opterius Commerce — not hosting services that happen to have a domain assigned.

Query Parameters

Parameter	Type	Description
`status`	string	Filter by status: `active`, `expired`, `transferred_away`, `cancelled`, `pending_transfer`
`page`	integer	Page number (default: `1`)
`per_page`	integer	Results per page (default: `15`, max: `100`)

Request Examples

List all domains:

curl "https://billing.example.com/api/v1/domains" \
  -H "Authorization: Bearer {your-token}"

List only active domains:

curl "https://billing.example.com/api/v1/domains?status=active" \
  -H "Authorization: Bearer {your-token}"

Response

{
  "data": [
    {
      "id": 15,
      "domain_name": "mysite.com",
      "tld": "com",
      "status": "active",
      "registration_date": "2023-06-10",
      "expiry_date": "2027-06-10",
      "auto_renew": true,
      "whois_privacy": true,
      "is_locked": true,
      "ns1": "ns1.opterius.net",
      "ns2": "ns2.opterius.net",
      "ns3": null,
      "ns4": null,
      "next_due_date": "2027-06-10"
    },
    {
      "id": 16,
      "domain_name": "myotherdomain.net",
      "tld": "net",
      "status": "active",
      "registration_date": "2025-01-20",
      "expiry_date": "2026-01-20",
      "auto_renew": false,
      "whois_privacy": false,
      "is_locked": true,
      "ns1": "ns1.externalhost.com",
      "ns2": "ns2.externalhost.com",
      "ns3": null,
      "ns4": null,
      "next_due_date": "2026-01-20"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 2
  }
}

Response Fields

Field	Type	Description
`id`	integer	Unique domain record ID
`domain_name`	string	Full domain name including TLD
`tld`	string	Top-level domain extension (e.g., `com`, `net`)
`status`	string	Domain status (see below)
`registration_date`	string	ISO 8601 date of initial registration
`expiry_date`	string	ISO 8601 date the domain expires at the registry
`auto_renew`	boolean	Whether auto-renewal is enabled
`whois_privacy`	boolean	Whether WHOIS privacy protection is active
`is_locked`	boolean	Whether the registrar transfer lock is enabled
`ns1` – `ns4`	string	Nameserver values; unused slots return `null`
`next_due_date`	string	ISO 8601 date when the next renewal invoice is due

Domain Status Values

Status	Meaning
`active`	Domain is registered and active
`expired`	Domain has passed its expiry date
`pending_transfer`	Incoming transfer is in progress
`transferred_away`	Domain was transferred to another registrar
`cancelled`	Domain registration was cancelled

[!IMPORTANT] Domain management actions — including nameserver updates, WHOIS privacy toggling, and initiating transfers — are available through the client portal only. These actions are not supported via the API in the current version.

[!TIP] Check auto_renew and expiry_date to build renewal reminder logic in your application. Domains expiring within 30 days with auto_renew: false should be flagged to the client.

Endpoint#

Query Parameters#

Request Examples#

Response#