Skip to content
digizeDocs

List sending domains

GET
/api/v1/email-sending/domains
curl --request GET \
  --url https://digize.com/api/v1/email-sending/domains \
  --header 'x-api-key: <x-api-key>'

Domains onboarded to Email Sending, with the records on their zones, their settings, the last 7 days’ volume and their reputation.

Needs the sites:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
Array<object>
object
id
required
string
domain
required
string
zoneDomain
required
string
status
required
string
Allowed values: active pending_dns verifying failed
records
required
Array<object>
object
type
required
string
Allowed values: CNAME TXT MX
name
required
string
value
required
string
priority
number
status
required
string
Allowed values: found missing mismatch
purpose
required
string
optional
boolean
error
required
string | null
addedAt
required
string format: date-time
verifiedAt
required
Any of:
string format: date-time
checkedAt
required
string format: date-time
emailPreview
required
boolean
dropSuppressed
required
boolean
deliveryEvents
required
boolean
daily
required
Array<number>
reputation
required
object
status
required
string
Allowed values: healthy warning at_risk
metrics
required
Array<object>
object
id
required
string
Allowed values: bounce spam_rejection complaint delivery
week
required
number
day
required
number
status
required
string
Allowed values: healthy warning at_risk
sent
required
number

Example 

[
  {
    "status": "active",
    "records": [
      {
        "type": "CNAME",
        "status": "found"
      }
    ],
    "reputation": {
      "status": "healthy",
      "metrics": [
        {
          "id": "bounce",
          "status": "healthy"
        }
      ]
    }
  }
]

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}