v1

latestOpenAPI 3.1.02026-07-2671111437.2 KB

Domains

List Domains

Lists all domains in your account (basic details for each domain).

get/core/v1/domains

Query parameters

perPageinteger

Maximum number of records to return per page for paginated list endpoints.

Per Page is the number of records to return per request. Per Page defaults to 250.

pageinteger

Page is which page to return.

sortstring

Sort specifies which domain property to order by.

dirstring

Dir indicates direction of sort. Possible values are 'asc' (default) or 'desc'.

domainNamestring

DomainName filters domains by exact domain name or wildcard (starts with '*').

tldstring

Tld filters on specific tld.

lockedboolean

Locked filters on locked domains.

createDatestring

CreateDate filters domains created on this date.

createDateStartstring

CreateDateStart filters domains created on or after this date.

createDateEndstring

CreateDateEnd filters domains created on or before this date.

expireDatestring

ExpireDate filters domains expiring on this date.

expireDateStartstring

ExpireDateStart filters domains with expire date on or after this date.

expireDateEndstring

ExpireDateEnd filters domains with expire date on or before this date.

privacyEnabledboolean

PrivacyEnabled indicates whether there is a privacy product associated with the domain.

isPremiumboolean

IsPremium indicates whether the domain is a premium domain.

autorenewEnabledboolean

AutorenewEnabled indicates if the domain will attempt to renew automatically before expiration.

orderIdinteger

OrderId specifies the order number of a domain purchase.

includeRenewalPriceboolean

IncludeRenewalPrice indicates whether to include renewal pricing information in the response.

Response

A successful response.

frominteger required

From is starting record count for current page.

lastPageinteger

LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.

nextPageinteger

NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.

tointeger required

To is ending record count for current page.

totalCountinteger required

TotalCount is total number of domains returned for request.

Example response

{
  "domains": [
    {
      "domainName": "example.com",
      "createDate": "2023-01-15T14:30:00Z",
      "expireDate": "2025-01-15T14:30:00Z",
      "autorenewEnabled": true,
      "locked": true,
      "locks": [
        "clientTransferProhibited",
        "clientHold"
      ],
      "transferLockExpiresAt": "2023-03-16T14:30:00Z",
      "privacyEnabled": true,
      "contacts": {
        "admin": {
          "firstName": "John",
          "lastName": "Doe",
          "companyName": "Example Inc.",
          "address1": "123 Main Street",
          "address2": "Suite 400",
          "city": "New York",
          "state": "NY",
          "zip": "10001",
          "country": "US",
          "email": "john.doe@example.com",
          "phone": "+15551234567",
          "fax": "+15557654321",
          "isVerified": true,
          "verificationId": 12345
        },
        "billing": {
          "firstName": "John",
          "lastName": "Doe",
          "companyName": "Example Inc.",
          "address1": "123 Main Street",
          "address2": "Suite 400",
          "city": "New York",
          "state": "NY",
          "zip": "10001",
          "country": "US",
          "email": "john.doe@example.com",
          "phone": "+15551234567",
          "fax": "+15557654321",
          "isVerified": true,
          "verificationId": 12345
        },
        "registrant": {
          "firstName": "John",
          "lastName": "Doe",
          "companyName": "Example Inc.",
          "address1": "123 Main Street",
          "address2": "Suite 400",
          "city": "New York",
          "state": "NY",
          "zip": "10001",
          "country": "US",
          "email": "john.doe@example.com",
          "phone": "+15551234567",
          "fax": "+15557654321",
          "isVerified": true,
          "verificationId": 12345
        },
        "tech": {
          "firstName": "John",
          "lastName": "Doe",
          "companyName": "Example Inc.",
          "address1": "123 Main Street",
          "address2": "Suite 400",
          "city": "New York",
          "state": "NY",
          "zip": "10001",
          "country": "US",
          "email": "john.doe@example.com",
          "phone": "+15551234567",
          "fax": "+15557654321",
          "isVerified": true,
          "verificationId": 12345
        }
      },
      "nameservers": [
        "ns1.example.com",
        "ns2.example.com"
      ],
      "renewalPrice": 12.99
    }
  ]
}