API · Domains

Retrieve Domain

Retrieve a domain and the DNS records needed to verify it (requires full access). Records include DMARC; TrackingCAA and CAA records are not returned.

GET/domains/{id}Full access

Request parameters

Parameter	Type	Description
`id` path · required	`string`	Opaque resource id.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X GET "$OPENSEND_BASE_URL/domains/YOUR_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "id": "YOUR_ID",
  "name": "example",
  "status": "pending",
  "created_at": "example",
  "region": "us-east-1",
  "open_tracking": false,
  "click_tracking": false,
  "tracking_subdomain": "example",
  "capabilities": {
    "sending": "enabled",
    "receiving": "enabled"
  },
  "tls": "opportunistic",
  "records": [
    {
      "record": "SPF",
      "name": "example",
      "type": "MX",
      "ttl": "example",
      "status": "pending",
      "value": "example",
      "priority": 0
    }
  ],
  "object": "domain"
}

Behavior and errors

Use the exact DNS records returned after provisioning. Do not invent or reuse another domain’s DKIM tokens.

Use a full-access credential. Resource IDs belong to your team; an unknown or foreign resource returns 404. See authentication, errors, rate limits, and compatibility for the shared contract.