The domain's retiring-sender ledger (console)

GET

/v1/admin/orgs/{org_id}/domains/{domain}/outbound-route/retirements

• Production
• Local

Read-only list of the domain’s retiring provider stints (viewer); the accounts a switch left decommissioning during their overlap window. The active route view clears previous_account_id on flip, so this is the only HTTP surface that observes a retiring stint. provider_state_json is never exposed. A domain the caller’s org does not own returns 404.

Authorizations

• ClerkSession

Parameters

Path Parameters

org_id

required

string

domain

required

string

Responses

200

The domain’s retiring-sender ledger rows.

The domain’s retiring-sender ledger rows (list envelope).

object

object

required

string

Allowed values: list

data

required

Array<object>

Provider-neutral progress for one old sending route being cleaned up after a switch. Infrastructure identifiers and snapshots are never exposed.

object

object

required

string

Allowed values: outbound_route_retirement

status

required

string

Allowed values: cleanup_scheduled

decommission_due_at

required

When the retiring stint’s records may be pruned.

string format: date-time

created_at

required

string format: date-time

has_more

boolean

next_cursor

string

nullable

401

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

403

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

404

Resource not found.

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