USusesend

GET /v1/domains

Changed on

Request

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"
      }
    ]
  }
]

Changes

  • f3f4be68abf8Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

  • 197721d96066Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status