Skip to content

The org's deliverability rollup (console)

GET
/v1/admin/orgs/{org_id}/reputation

Read-only deliverability rollup for the org (viewer): status badge, sending status, latest metrics window, and open-finding count.

org_id
required
string

The org reputation rollup.

The org’s deliverability rollup: derived status badge, sending readiness, the latest metrics window, and open-finding count.

object
object
required
string
Allowed values: reputation
org_id
required
string
status
required

UI badge: healthy/at_risk/paused/enforced/unknown.

string
sending_status
required

The org’s effective sending status.

string
configured
required

Whether sending is configured.

boolean
last_checked_at
string format: date-time
metrics
required

The latest window’s Sends/Bounces/Complaints rollup for the org.

object
window_start
string format: date-time
window_end
string format: date-time
sends
required
integer
bounces
required
integer
complaints
required
integer
bounce_rate
required
number
complaint_rate
required
number
open_findings
required

Count of open findings for the org.

integer

Missing or invalid credential.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean

Authenticated but lacking the required scope, or out of quota.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean