# List Domains

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

Endpoint: GET /core/v1/domains
Version: 1.3.1
Security: BasicAuth

## Query parameters:

  - `perPage` (integer)
    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 200 fields (application/json):

  - `domains` (array, required)
    Domains is the list of domains in your account.

  - `domains.domainName` (string, required)
    The punycode-encoded value of the domain name.
    Example: "example.com"

  - `domains.createDate` (string, required)
    The date and time when the domain was created at the registry.
    Example: "2023-01-15T14:30:00Z"

  - `domains.expireDate` (string, required)
    The date and time when the domain will expire.
    Example: "2025-01-15T14:30:00Z"

  - `domains.autorenewEnabled` (boolean, required)
    Indicates whether the domain is set to renew automatically before expiration.
    Example: true

  - `domains.locked` (boolean, required)
    Indicates if the domain is locked, preventing transfers to another registrar.
    Example: true

  - `domains.privacyEnabled` (boolean, required)
    Indicates if Whois Privacy is enabled for this domain.
    Example: true

  - `domains.contacts` (object, required)
    Contacts stores the contact information for the roles related to domains.

  - `domains.contacts.admin` (object)
    Contact contains all relevant contact data for a domain registrant.

  - `domains.contacts.admin.firstName` (string, required)
    First name of the contact.
    Example: "John"

  - `domains.contacts.admin.lastName` (string, required)
    Last name of the contact.
    Example: "Doe"

  - `domains.contacts.admin.companyName` (string,null)
    Company name of the contact. Leave blank if the contact is an individual, as some registries may assume it is a corporate entity otherwise.
    Example: "Example Inc."

  - `domains.contacts.admin.address1` (string, required)
    The first line of the contact's address.
    Example: "123 Main Street"

  - `domains.contacts.admin.address2` (string,null)
    The second line of the contact's address (optional).
    Example: "Suite 400"

  - `domains.contacts.admin.city` (string, required)
    City of the contact's address.
    Example: "New York"

  - `domains.contacts.admin.state` (string, required)
    State or Province of the contact's address.
    Example: "NY"

  - `domains.contacts.admin.zip` (string, required)
    ZIP or Postal Code of the contact's address.
    Example: "10001"

  - `domains.contacts.admin.country` (string, required)
    Country code for the contact's address. Must be an ISO 3166-1 alpha-2 country code.
    Example: "US"

  - `domains.contacts.admin.email` (string, required)
    Email address of the contact. Must be a valid email format. The validation is performed against the  syntax in [RFC 822](https://datatracker.ietf.org/doc/html/rfc822)
    Example: "john.doe@example.com"

  - `domains.contacts.admin.phone` (string, required)
    Phone number of the contact. Should follow the E.164 international format: "+[country code][number]".
    Example: "+15551234567"

  - `domains.contacts.admin.fax` (string,null)
    Fax number of the contact. Should follow the E.164 international format: "+[country code][number]".
    Example: "+15557654321"

  - `domains.contacts.billing` (object)
    Contact contains all relevant contact data for a domain registrant.

  - `domains.contacts.registrant` (object)
    Contact contains all relevant contact data for a domain registrant.

  - `domains.contacts.registrant.companyName` (string,null)
    Company name of the contact. Leave blank if the contact is an individual. Please be advised that ICANN policy links the "Company Name" field (Organization) in your domain's contact details to its legal ownership. If this field contains information, the listed organization is considered the legal "Registered Name Holder" (domain owner).
    Example: "Example Inc."

  - `domains.contacts.tech` (object)
    Contact contains all relevant contact data for a domain registrant.

  - `domains.nameservers` (array, required)
    The list of nameservers assigned to this domain. If unspecified, it defaults to the account's default nameservers.
    Example: ["ns1.example.com","ns2.example.com"]

  - `domains.renewalPrice` (number, required)
    The cost to renew the domain. This may be required for the RenewDomain operation.
    Example: 12.99

  - `from` (integer, required)
    From is starting record count for current page.

  - `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.

  - `to` (integer, required)
    To is ending record count for current page.

  - `totalCount` (integer, required)
    TotalCount is total number of domains returned for request.

## Response 400 fields (application/json):

  - `message` (string)
    A human-readable message providing more details about the error
    Example: "Bad Request"

  - `details` (string,null)
    Additional context or information about the error
    Example: "'domainName' cannot be null"

## Response 401 fields (application/json):

  - `message` (string, required)
    A human-readable message providing more details about the error
    Example: "Unauthorized"

## Response 429 fields (application/json):

  - `message` (string)
    A human-readable message providing more details about the error
    Example: "Rate Limit Exceeded"

## Response 500 fields (application/json):

  - `message` (string, required)
    A human-readable message providing more details about the error.
    Example: "Internal Server Error"

  - `details` (string,null)
    Additional context or information about the error.
    Example: "Something went wrong."