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
  }
}

Changes

Changed in 4 of the 52 revisions of this API.2119

  • v253dd09c3a13911See the full diff
    • removed the required property data/items/trustee_service from the response with the 200 status

      response-required-property-removed

    • added the required property data/items/trustee to the response with the 200 status

      response-required-property-added

    • added the required property data/items/trustee_service to the response with the 200 status

      response-required-property-added

    • the response property data became required for the status 200

      response-property-became-required

    • the response property data/items/account_id became required for the status 200

      response-property-became-required

    • the response property data/items/auto_renew became required for the status 200

      response-property-became-required

    • the response property data/items/created_at became required for the status 200

      response-property-became-required

    • the response property data/items/expires_at became required for the status 200

      response-property-became-required

    • the response property data/items/id became required for the status 200

      response-property-became-required

    • the response property data/items/name became required for the status 200

      response-property-became-required

    • the response property data/items/private_whois became required for the status 200

      response-property-became-required

    • the response property data/items/registrant_id became required for the status 200

      response-property-became-required

    • the response property data/items/state became required for the status 200

      response-property-became-required

    • the response property data/items/unicode_name became required for the status 200

      response-property-became-required

    • the response property data/items/updated_at became required for the status 200

      response-property-became-required

    • the response property pagination became required for the status 200

      response-property-became-required

    • the response property pagination/current_page became required for the status 200

      response-property-became-required

    • the response property pagination/per_page became required for the status 200

      response-property-became-required

    • the response property pagination/total_entries became required for the status 200

      response-property-became-required

    • the response property pagination/total_pages became required for the status 200

      response-property-became-required

    • the response property data/items/expires_at became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/registrant_id became nullable for the status 200

      response-property-became-nullable

    • the response property data became optional for the status 200

      response-property-became-optional

    • the response property data/items/account_id became optional for the status 200

      response-property-became-optional

    • the response property data/items/auto_renew became optional for the status 200

      response-property-became-optional

    • the response property data/items/created_at became optional for the status 200

      response-property-became-optional

    • the response property data/items/expires_at became optional for the status 200

      response-property-became-optional

    • the response property data/items/id became optional for the status 200

      response-property-became-optional

    • the response property data/items/name became optional for the status 200

      response-property-became-optional

    • the response property data/items/private_whois became optional for the status 200

      response-property-became-optional

    • the response property data/items/registrant_id became optional for the status 200

      response-property-became-optional

    • the response property data/items/state became optional for the status 200

      response-property-became-optional

    • the response property data/items/unicode_name became optional for the status 200

      response-property-became-optional

    • the response property data/items/updated_at became optional for the status 200

      response-property-became-optional

    • the response property pagination became optional for the status 200

      response-property-became-optional

    • the response property pagination/current_page became optional for the status 200

      response-property-became-optional

    • the response property pagination/per_page became optional for the status 200

      response-property-became-optional

    • the response property pagination/total_entries became optional for the status 200

      response-property-became-optional

    • the response property pagination/total_pages became optional for the status 200

      response-property-became-optional

    • removed the required property data/items/trustee from the response with the 200 status

      response-required-property-removed

    This revision also has 25 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog