Skip to content

List Deliverability Findings

GET
/deliverability/findings

Individual deliverability findings the daily routine raised, newest first.

Every filter is CLOSED to the values the lifecycle actually uses, so a typo is a 422 naming them rather than a silently empty list.

An org whose schema predates the findings table gets an empty list, not an error - absence of findings and absence of the table look the same here on purpose.

Authorizations

Parameters

Query Parameters

status
Any of:
string
/^(open|proposed|awaiting_approval|in_remediation|resolved|failed|dismissed)$/

Filter by lifecycle state.

severity
Any of:
string
/^(info|warn|critical)$/

Filter by severity.

signal
Any of:
string
/^[a-z_]{1,30}$/

Filter by signal name, e.g. dmarc, mailbox_health.

limit

Newest first. The app’s own ceiling.

integer
default: 50 >= 1 <= 200

Newest first. The app’s own ceiling.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

A named collection ({"plans": [...]}) keeps its own key AND gains items, so a caller can page every list surface the same way without memorising which key each route chose.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string