List Tracking Domains

The workspace's custom tracking domain and the shared default.

GEThttps://api.foxreach.io/api/v1/tracking-domains

Requires an API key with the read scope.

Response#

dataobject

Result.

Show data

domainsarray

The workspace's tracking domains, newest first.

Show domains

idstring

Tracking domain identifier.

domainstring

The tracking subdomain.

statusstring

pending, verifying, active or failed.

cnameTargetstring

The hostname to point your CNAME record at.

sslStatusstring

Certificate status, for example pending_validation or active. null until provisioning has run.

failureReasonstring

Why provisioning or verification failed, or null.

verifiedAtstring

ISO 8601 timestamp, or null.

lastCheckedAtstring

ISO 8601 timestamp, or null.

createdAtstring

ISO 8601 timestamp.

defaultDomainstring

The shared tracking domain used when you have no active custom one.

configuredboolean

Whether custom tracking domains are available on this environment.

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	API key does not have the required scope: `read`

Rate Limit#

100 requests per minute, per API key. Fixed 60-second window.
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset (unix epoch seconds).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns (Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.

Request

curl -X GET "https://api.foxreach.io/api/v1/tracking-domains" \
  -H "X-API-Key: otr_your_key"

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
result = client.tracking_domains.list()

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
const result = await client.trackingDomains.list();

Response

{
  "data": {
    "domains": [
  {
      "id": "trk_abc123",
      "domain": "track.yourcompany.com",
      "status": "active",
      "cnameTarget": "cname.foxtrk.com",
      "sslStatus": "active",
      "failureReason": null,
      "verifiedAt": "2026-10-31T10:20:00",
      "lastCheckedAt": "2026-10-31T10:20:00",
      "createdAt": "2026-10-31T10:00:00"
    }
    ],
    "defaultDomain": "foxtrk.com",
    "configured": true
  }
}

Was this page helpful?

View as MarkdownLast updated November 2, 2026