Sign in

v1

latestOpenAPI 3.0.02026-07-1733092.8 KB

get/v1/domains

Response

Retrieve domains accessible by the API key

idnumber required

The ID of the domain

namestring required

The name of the domain

teamIdnumber required

The ID of the team

status'NOT_STARTED' | 'PENDING' | 'SUCCESS' | 'FAILED' | 'TEMPORARY_FAILURE' required
regionstring
clickTrackingboolean
openTrackingboolean
publicKeystring required
dkimStatusstring nullable
spfDetailsstring nullable
createdAtstring required
updatedAtstring required
dmarcAddedboolean
isVerifyingboolean
errorMessagestring nullable
subdomainstring nullable
verificationErrorstring nullable
lastCheckedTimestring nullable

Example response

[
  {
    "id": 1,
    "name": "example.com",
    "teamId": 1,
    "dnsRecords": [
      {
        "type": "TXT",
        "name": "mail",
        "value": "v=spf1 include:amazonses.com ~all",
        "ttl": "Auto",
        "priority": "10"
      }
    ]
  }
]
All 33 operations