v1

latestSwagger 2.02026-07-136573327.3 KB

Retrieve a list of Domains for the specified Shopper

get/v1/domains

Query parameters

statusesstring[]

Only include results with status value in the specified set

statusGroupsstring[]

Only include results with status value in any of the specified groups

limitinteger

Maximum number of domains to return

markerstring

Marker Domain to use as the offset in results

includesstring[]

Optional details to be included in the response

modifiedDatestring iso-datetime

Only include results that have been modified since the specified date

Headers

X-Shopper-Idstring

Shopper ID whose domains are to be retrieved

Response

Request was successful

authCodestring

Authorization code for transferring the Domain

createdAtstring date-time required

Date and time when this domain was created

deletedAtstring date-time

Date and time when this domain was deleted

transferAwayEligibleAtstring date-time

Date and time when this domain is eligible to transfer

domainstring required

Name of the domain

domainIdnumber double required

Unique identifier for this Domain

expirationProtectedboolean required

Whether or not the domain is protected from expiration

expiresstring date-time

Date and time when this domain will expire

exposeWhoisboolean

Whether or not the domain contact details should be shown in the WHOIS

holdRegistrarboolean required

Whether or not the domain is on-hold by the registrar

lockedboolean required

Whether or not the domain is locked to prevent transfers

nameServersstring[]

Fully-qualified domain names for DNS servers

privacyboolean required

Whether or not the domain has privacy protection

registrarCreatedAtstring iso-datetime

Date and time when this domain was created by the registrar

renewAutoboolean required

Whether or not the domain is configured to automatically renew

renewDeadlinestring date-time required

Date the domain must renew on

renewableboolean

Whether or not the domain is eligble for renewal based on status

statusstring required

Processing status of the domain <ul>

<li>ACTIVE - All is well</li> <li>AWAITING* - System is waiting for the end-user to complete an action</li> <li>CANCELLED* - Domain has been cancelled, and may or may not be reclaimable</li> <li>CONFISCATED - Domain has been confiscated, usually for abuse, chargeback, or fraud</li> <li>DISABLED* - Domain has been disabled</li> <li>EXCLUDED* - Domain has been excluded from Firehose registration</li> <li>EXPIRED* - Domain has expired</li> <li>FAILED* - Domain has failed a required action, and the system is no longer retrying</li> <li>HELD* - Domain has been placed on hold, and likely requires intervention from Support</li> <li>LOCKED* - Domain has been locked, and likely requires intervention from Support</li> <li>PARKED* - Domain has been parked, and likely requires intervention from Support</li> <li>PENDING* - Domain is working its way through an automated workflow</li> <li>RESERVED* - Domain is reserved, and likely requires intervention from Support</li> <li>REVERTED - Domain has been reverted, and likely requires intervention from Support</li> <li>SUSPENDED* - Domain has been suspended, and likely requires intervention from Support</li> <li>TRANSFERRED* - Domain has been transferred out</li> <li>UNKNOWN - Domain is in an unknown state</li> <li>UNLOCKED* - Domain has been unlocked, and likely requires intervention from Support</li> <li>UNPARKED* - Domain has been unparked, and likely requires intervention from Support</li> <li>UPDATED* - Domain ownership has been transferred to another account</li> </ul>

transferProtectedboolean required

Whether or not the domain is protected from transfer