The domain's current outbound provider route (console)

GET

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

• Production
• Local

Read-only view of the domain’s assigned outbound provider account and route state (viewer). An unassigned domain returns route_state “unassigned” (it routes direct by fail-safe). 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 outbound route.

A provider-neutral view of a domain’s current outbound route. An unassigned domain has assigned=false and route_state “unassigned” (it routes direct by fail-safe).

object

object

required

string

Allowed values: outbound_route

domain

required

string

assigned

required

True when a route row exists for the domain.

boolean

route_state

string

Allowed values: unassigned provisioning active switching deprovisioning failed paused

status

required

string

Allowed values: pending setting_up ready needs_attention

switched_at

string format: date-time

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