domainListResponse

No description available in the specification.

Fields

Field	Type	Required	Description
domains	domainResponse[]	yes	Domain list for the current result page.
total_items	integer	yes	Total number of matching domains.
total_pages	integer	yes	Total number of available pages.
page	integer	yes	Current page number.
page_size	integer	yes	Number of items returned per page.
search	string	yes	Applied search term.
filters	domainListFilter[]	yes	Applied filters.
sort_by	domainListSortKey	yes	(domain, expires_at, cancelled, primary_nameserver, dnssec_state, owner, registered_at)
sort_order	sortOrder	yes	(asc, desc)

Example

{
  "domains": [
    {
      "domain": "www.example.com",
      "sld": "string",
      "tld": "string",
      "favorite": true,
      "owner_contact_id": 0,
      "owner": "string",
      "primary_nameserver": "string",
      "dnssec_state": "active",
      "auto_renew": true,
      "cancelled": true,
      "registered_at": 0,
      "expires_at": 0
    }
  ],
  "total_items": 0,
  "total_pages": 0,
  "page": 0,
  "page_size": 0,
  "search": "string",
  "filters": [
    "cancelled"
  ],
  "sort_by": "domain",
  "sort_order": "asc"
}

Used by

• GET /domains