Skip to main content

DomainListResponse

data object[]required
  • Array [
  • idstringrequired

    Unique domain identifier.

    namestringrequired

    Fully qualified domain name.

    Example: notifications.example.com
    statusstringrequired

    Domain verification status.

    Possible values: [unverified, verifying, active]

    regionstringrequired

    Sending infrastructure region.

    Example: eu-west-1
    open_tracking object
    marketingboolean
    transactionalboolean
    click_tracking object
    marketingboolean
    transactionalboolean
    last_dns_check_atstring<date-time>nullable

    When DNS records were last checked.

    created_atstring<date-time>required
    updated_atstring<date-time>
    dns_records object[]required

    DNS records that need to be configured for this domain.

  • Array [
  • typestringrequired

    DNS record type.

    Possible values: [TXT, MX]

    hoststringrequired

    Full hostname to set this record on.

    Example: send._domainkey.notifications.example.com
    valuestringrequired

    Expected DNS record value.

    Example: v=DKIM1; k=rsa; p=MIIBIj...
    statusstringrequired

    Verification status of this record.

    Possible values: [unverified, verifying, active, failed]

    priorityinteger

    MX record priority. Only present for MX records.

    Example: 10
    purposestringrequired

    Whether this record is for sending (SPF, DKIM, DMARC) or receiving (MX).

    Possible values: [sending, receiving]

    kindstring

    Semantic kind of the record (so clients can label rows without parsing values).

    Possible values: [spf, dkim, dmarc, mx_inbound]

    last_verification_errorstring

    Human-readable explanation of the most recent verification failure. Empty when verified.

    requiredbooleanrequired

    Whether this record must be verified for the domain to become active.

  • ]
  • ]
  • has_morebooleanrequired

    Whether there are more items available after this page.

    next_cursorstring

    Cursor to use as starting_after for the next page.

    DomainListResponse
    {
    "data": [
    {
    "id": "d_abc123",
    "name": "notifications.example.com",
    "status": "unverified",
    "region": "eu-west-1",
    "open_tracking": {
    "marketing": true,
    "transactional": false
    },
    "click_tracking": {
    "marketing": true,
    "transactional": false
    },
    "created_at": "2026-04-21T10:00:00Z",
    "updated_at": "2026-04-21T10:00:00Z",
    "dns_records": [
    {
    "type": "TXT",
    "host": "default.notifications",
    "value": "v=spf1 include:send.epostix.com ~all",
    "status": "unverified",
    "purpose": "sending",
    "required": true
    },
    {
    "type": "TXT",
    "host": "send._domainkey.notifications",
    "value": "v=DKIM1; k=rsa; p=MIIBIjANBgkqhki...",
    "status": "unverified",
    "purpose": "sending",
    "required": true
    },
    {
    "type": "TXT",
    "host": "_dmarc.notifications",
    "value": "v=DMARC1; p=none;",
    "status": "unverified",
    "purpose": "sending",
    "required": false
    },
    {
    "type": "MX",
    "host": "default.notifications",
    "value": "mxa.send.epostix.com",
    "status": "unverified",
    "priority": 10,
    "purpose": "receiving",
    "required": false
    }
    ]
    }
    ],
    "has_more": true,
    "next_cursor": "string"
    }