Domains

Retrieve a single domain

get/domains/{domain_id}

Path parameters

domain_idstring required

The ID of the domain.

Response

OK

objectstring

The type of object.

idstring

The ID of the domain.

namestring

The name of the domain.

status'pending' | 'verified' | 'failed' | 'not_started' | 'partially_verified' | 'partially_failed'

The status of the domain.

created_atstring

The date and time the domain was created.

regionstring

The region where the domain is hosted.

open_trackingboolean

Whether open tracking is enabled for this domain.

click_trackingboolean

Whether click tracking is enabled for this domain.

tracking_subdomainstring

The subdomain used for click and open tracking.

Example response

{
  "object": "domain",
  "id": "d91cd9bd-1176-453e-8fc1-35364d380206",
  "name": "example.com",
  "status": "not_started",
  "created_at": "2023-04-26 20:21:26.347412+00",
  "region": "us-east-1"
}

Changes

Changed in 9 of the 73 revisions of this API.1217

    • api operation id domains/get was added

      api-operation-id-added

    • the created_at response's property type/format changed from string/date-time to string/ for status 200

      response-property-type-changed

    • added the new failed enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new not_started enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new partially_failed enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new partially_verified enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new pending enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new verified enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new CAA enum value to the records/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new TrackingCAA enum value to the records/items/record response property for the response status 200

      response-property-enum-value-added

    • added the new Tracking enum value to the records/items/record response property for the response status 200

      response-property-enum-value-added

    • added the optional property click_tracking to the response with the 200 status

      response-optional-property-added

    • added the optional property open_tracking to the response with the 200 status

      response-optional-property-added

    • added the optional property tracking_subdomain to the response with the 200 status

      response-optional-property-added

    • added the optional property capabilities to the response with the 200 status

      response-optional-property-added

    • removed the optional property capability from the response with the 200 status

      response-optional-property-removed

  • b5d5b993ee1d111See the full diff
    • added the new CNAME enum value to the records/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new DKIM enum value to the records/items/record response property for the response status 200

      response-property-enum-value-added

    • added the new MX enum value to the records/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new Receiving enum value to the records/items/record response property for the response status 200

      response-property-enum-value-added

    • added the new SPF enum value to the records/items/record response property for the response status 200

      response-property-enum-value-added

    • added the new TXT enum value to the records/items/type response property for the response status 200

      response-property-enum-value-added

    • added the new failed enum value to the records/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new not_started enum value to the records/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new pending enum value to the records/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new temporary_failure enum value to the records/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new verified enum value to the records/items/status response property for the response status 200

      response-property-enum-value-added

    • added the optional property capability to the response with the 200 status

      response-optional-property-added

    • endpoint added

      endpoint-added