Retrieve a list of Domains for the specified Shopper
View as MarkdownReturns a paginated list of domains owned by the authenticated account.
Full description
Returns a paginated list of domains owned by the authenticated account. Supports filtering by status and optional inclusion of contacts, nameservers, and authCode in each record.
Authorization
bearerAuth Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .
In: header
Query Parameters
Only include results with status value in the specified set
Only include results with status value in any of the specified groups
Maximum number of domains to return
1 <= value <= 1000Marker Domain to use as the offset in results
Optional details to be included in the response
Only include results that have been modified since the specified date
iso-datetimeHeader Parameters
Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account.
Response Body
curl -X GET "https://example.com/v1/domains"[ { "authCode": "string", "contactAdmin": { "addressMailing": { "address1": "string", "address2": "string", "city": "string", "country": "AC", "postalCode": "string", "state": "string" }, "email": "user@example.com", "fax": "string", "jobTitle": "string", "nameFirst": "string", "nameLast": "string", "nameMiddle": "string", "organization": "string", "phone": "string" }, "contactBilling": { "addressMailing": { "address1": "string", "address2": "string", "city": "string", "country": "AC", "postalCode": "string", "state": "string" }, "email": "user@example.com", "fax": "string", "jobTitle": "string", "nameFirst": "string", "nameLast": "string", "nameMiddle": "string", "organization": "string", "phone": "string" }, "contactRegistrant": { "addressMailing": { "address1": "string", "address2": "string", "city": "string", "country": "AC", "postalCode": "string", "state": "string" }, "email": "user@example.com", "fax": "string", "jobTitle": "string", "nameFirst": "string", "nameLast": "string", "nameMiddle": "string", "organization": "string", "phone": "string" }, "contactTech": { "addressMailing": { "address1": "string", "address2": "string", "city": "string", "country": "AC", "postalCode": "string", "state": "string" }, "email": "user@example.com", "fax": "string", "jobTitle": "string", "nameFirst": "string", "nameLast": "string", "nameMiddle": "string", "organization": "string", "phone": "string" }, "createdAt": "2019-08-24T14:15:22Z", "deletedAt": "2019-08-24T14:15:22Z", "transferAwayEligibleAt": "2019-08-24T14:15:22Z", "domain": "string", "domainId": 0.1, "expirationProtected": true, "expires": "2019-08-24T14:15:22Z", "exposeWhois": true, "holdRegistrar": true, "locked": true, "nameServers": [ "string" ], "privacy": true, "registrarCreatedAt": "string", "renewAuto": true, "renewDeadline": "2019-08-24T14:15:22Z", "renewable": true, "status": "string", "transferProtected": true }]Agent & Automation Notes
domains.domain:read, domains.domain:create, domains.domain:delete, domains.domain:update, domains.contact:update, domains.dns:update, domains.transfer:executeRelated
Last updated on
How is this guide?