Skip to content

Get Mailbox Health

GET
/mailboxes/{mailbox_id}/health

Deliverability health for one mailbox.

Authorizations

Parameters

Path Parameters

mailbox_id
required

Mailbox id.

integer
>= 1

Mailbox id.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Deliverability health for a single mailbox.

object
mailbox_id
Any of:
integer
status
Any of:
string
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
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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