List tracking domains

Search Documentation

Search across all developer documentation

entities

List tracking domains

GET /v1/tracking-domains
Auth required api.tracking.view

Returns the org's CNAME-based open/click tracking subdomains and the DNS records you need to publish for each. status is a coalesced view across DNS-record verification and SES-identity verification: verified requires both checks to pass; failed covers DNS failures; anything else is pending. verified_at is the time of the last successful verification and stays null until then. This endpoint is read-only — add or remove tracking domains via the SendOps dashboard. Sorted newest-first.

Query parameters

limit integer optional

Page size (1–200). Default 50.

cursor string optional

Opaque cursor returned from the previous page.

Responses

Errors follow the RFC 7807 problem format — see the error reference.

200 Tracking domains, newest-first application/json
data array<object> required

Each entry in data:

domain string required

Tracking subdomain, e.g. track.example.com.

status string enum required

Coalesced verification state. verified requires both DNS-record verification and the SES identity to be verified; failed covers DNS-failed and DNS-invalid sub-states; otherwise pending.

One of: pending, verified, failed

ssl_status string enum required

active when HTTPS is provisioned for the tracking host; inactive for HTTP-only.

One of: active, inactive

dns_records array<object> required

DNS records the customer must publish for verification to succeed. The first record is the tracking subdomain's CNAME (pointing at the SendOps redirect host); the remaining records are the SES DKIM CNAMEs.

Each entry in dns_records:

type string required
name string required
value string required
created_at string<date-time> required
verified_at string<date-time> | null required

Time of the most recent successful verification. null until the first verification passes.

pagination object required

Fields of pagination:

has_more boolean required
next_cursor string | null optional
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
422 Query parameter or path value failed validation application/problem+json
429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json