Skip to content
builders.ac

Deliverability API · Alpha / unstable

Retrieve the 28-day domain-check grid and blacklist overview

GET
/checks
curl --request GET \
  --url https://api.builders.ac/api/deliverability/v1alpha1/checks \
  --header 'Authorization: Bearer <token>'

The check rows are data-driven. Use each returned check id when requesting detail; do not maintain a client-side list. This public resource is always masked and rejects the staff-only debug query parameter. Non-healthy, non-blacklist cells are reported as not-tested; blacklist warnings and errors remain visible.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
sender_id
string
/^snd_[0-9a-z]{26}$/

Restrict data to one sender owned by the authenticated account.

domain_id
string
/^dom_[0-9a-z]{26}$/

Restrict data to one domain owned by the authenticated account.

Responses

Section titled “Responses”

200

Section titled “200”

Domain-check overview

Media typeapplication/json
object
checks
required
Array<object>
object
id
required
string
label
required
string
group
required
string
kind
string
history
required
Array<object>
object
date
required
string format: date
statuses
required
object
key
additional properties
string
Allowed values: healthy warning error not-tested
blacklists
required
Array<object>
object
zone
required
string
name
required
string
kind
required
string
status
required
string
Allowed values: clear listed unknown
checked
required
string | null format: date-time
detail
required
string
Example
{
  "history": [
    {
      "statuses": {
        "additionalProperty": "healthy"
      }
    }
  ],
  "blacklists": [
    {
      "status": "clear"
    }
  ]
}

401

Section titled “401”

RFC 9457 problem details

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
code
required
string
retryable
required
boolean
correlation_id
required
string
retry_after
string format: date-time
errors
object
key
additional properties
Array<string>
key
additional properties
any
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "retryable": true,
  "correlation_id": "example",
  "retry_after": "2026-04-15T12:00:00Z",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Section titled “403”

RFC 9457 problem details

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
code
required
string
retryable
required
boolean
correlation_id
required
string
retry_after
string format: date-time
errors
object
key
additional properties
Array<string>
key
additional properties
any
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "retryable": true,
  "correlation_id": "example",
  "retry_after": "2026-04-15T12:00:00Z",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

404

Section titled “404”

RFC 9457 problem details

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
code
required
string
retryable
required
boolean
correlation_id
required
string
retry_after
string format: date-time
errors
object
key
additional properties
Array<string>
key
additional properties
any
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "retryable": true,
  "correlation_id": "example",
  "retry_after": "2026-04-15T12:00:00Z",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

422

Section titled “422”

RFC 9457 problem details

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
code
required
string
retryable
required
boolean
correlation_id
required
string
retry_after
string format: date-time
errors
object
key
additional properties
Array<string>
key
additional properties
any
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "retryable": true,
  "correlation_id": "example",
  "retry_after": "2026-04-15T12:00:00Z",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

429

Section titled “429”

RFC 9457 problem details

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
code
required
string
retryable
required
boolean
correlation_id
required
string
retry_after
string format: date-time
errors
object
key
additional properties
Array<string>
key
additional properties
any
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "retryable": true,
  "correlation_id": "example",
  "retry_after": "2026-04-15T12:00:00Z",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

500

Section titled “500”

RFC 9457 problem details

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
code
required
string
retryable
required
boolean
correlation_id
required
string
retry_after
string format: date-time
errors
object
key
additional properties
Array<string>
key
additional properties
any
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "retryable": true,
  "correlation_id": "example",
  "retry_after": "2026-04-15T12:00:00Z",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

503

Section titled “503”

RFC 9457 problem details

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
code
required
string
retryable
required
boolean
correlation_id
required
string
retry_after
string format: date-time
errors
object
key
additional properties
Array<string>
key
additional properties
any
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "retryable": true,
  "correlation_id": "example",
  "retry_after": "2026-04-15T12:00:00Z",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}