Sign in

v1

latestOpenAPI 3.1.12026-07-17111158225.7 KB
domains

List domains

Lists the domains in the account.

get/{account}/domains

Path parameters

accountinteger required

The account id

Query parameters

name_likestring

Only include results with a name field containing the given string

registrant_idinteger

Only include results with the registrant_id field matching the given value

sort'id:asc' | 'id:desc' | 'name:asc' | 'name:desc' | 'expiration:asc' | 'expiration:desc'

Sort results. Default sorting is ascending by name.

Response

Domain listing.

Example response

{
  "data": [
    {
      "id": 1,
      "account_id": 1010,
      "registrant_id": null,
      "name": "example-alpha.com",
      "unicode_name": "example-alpha.com",
      "state": "hosted",
      "auto_renew": false,
      "private_whois": false,
      "expires_at": null,
      "trustee": false,
      "created_at": "2014-12-06T15:56:55Z",
      "updated_at": "2015-12-09T00:20:56Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 30,
    "total_entries": 2,
    "total_pages": 1
  }
}