Skip to main content
GET
/
core
/
v1
/
domains
List Domains
curl --request GET \
  --url https://api.dev.name.com/core/v1/domains \
  --header 'Authorization: Basic <encoded-value>'
{
  "domains": [
    {
      "domainName": "example.com",
      "createDate": "2023-01-15T14:30:00Z",
      "expireDate": "2025-01-15T14:30:00Z",
      "autorenewEnabled": true,
      "locked": true,
      "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
        },
        "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
        },
        "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
        },
        "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
        }
      },
      "nameservers": {
        "0": "ns1.example.com",
        "1": "ns2.example.com"
      },
      "renewalPrice": 12.99
    }
  ],
  "from": 123,
  "lastPage": 123,
  "nextPage": 123,
  "to": 123,
  "totalCount": 123
}

Authorizations

​
Authorization
string
header
required

Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.

Query Parameters

​
perPage
integer
default:1000

Per Page is the number of records to return per request. Per Page defaults to 1,000.

​
page
integer

Page is which page to return.

​
sort
string

Sort specifies which domain property to order by.

​
dir
string

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

​
domainName
string

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

​
tld
string

Tld filters on specific tld.

​
locked
boolean

Locked filters on locked domains.

​
createDate
string

CreateDate filters domains created on this date.

​
createDateStart
string

CreateDateStart filters domains created on or after this date.

​
createDateEnd
string

CreateDateEnd filters domains created on or before this date.

​
expireDate
string

ExpireDate filters domains expiring on this date.

​
expireDateStart
string

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

​
expireDateEnd
string

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

​
privacyEnabled
boolean

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

​
isPremium
boolean

IsPremium indicates whether the domain is a premium domain.

​
autorenewEnabled
boolean

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

​
orderId
integer

OrderId specifies the order number of a domain purchase.

Response

A successful response.

ListDomainsResponse is the response from a list request, it contains the paginated list of Domains.

​
domains
object[]
required

Domains is the list of domains in your account.

​
from
integer
required

From is starting record count for current page.

​
to
integer
required

To is ending record count for current page.

​
totalCount
integer
required

TotalCount is total number of domains returned for request.

​
lastPage
integer

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.

​
nextPage
integer

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.

⌘I