GoDaddy
Support
API ReferenceDomainDomain LifecycleDomains & DNSv1 (Legacy)Manage Domain SettingsRetrieve details for the specified Domain GET

Retrieve details for the specified Domain

View as Markdown

Returns the full DomainDetail object including status, contacts, nameservers, lock state, privacy flag, and expiration timestamp.

GET
/v1/domains/{domain}

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

domain*string

Domain name whose details are to be retrieved

Header Parameters

X-Shopper-Id?string

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/string"
{  "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",  "exposeRegistrantOrganization": true,  "exposeWhois": true,  "holdRegistrar": true,  "locked": true,  "nameServers": [    "string"  ],  "privacy": true,  "registrarCreatedAt": "string",  "renewAuto": true,  "renewDeadline": "2019-08-24T14:15:22Z",  "status": "string",  "subaccountId": "string",  "transferProtected": true,  "verifications": {    "domainName": {      "status": "APPROVED"    },    "realName": {      "status": "APPROVED"    }  }}

Agent & Automation Notes

Scopesdomains.domain:read, domains.domain:create, domains.domain:delete, domains.domain:update, domains.contact:update, domains.dns:update, domains.transfer:execute
Rate limit60 req/min per credential
On failureGET operations are safe to retry. PUT/PATCH DNS are idempotent by shape. POST purchase is NOT idempotent — verify state before retrying.

Related

Last updated on

How is this guide?