Skip to main content
GET
List everything holding dispatch

Authorizations

X-API-Key
string
header
required

Query Parameters

include_released
boolean
default:false
scope
enum<string> | null

How much of dispatch a pause holds.

global holds every Domain in the organization; domain holds one Domain; lane holds one named dispatch lane; bucket holds one provider rate bucket (the shape automatic backoffs use); batch holds one batch.

Available options:
global,
domain,
lane,
bucket,
batch
sort_by
enum<string>
default:created_at

Allowed sort fields when listing dispatch pauses.

Available options:
created_at,
expires_at
order
enum<string>
default:desc

Sort direction for config-family list endpoints (D-08).

Renders as a real named enum (components.schemas["Order"]) in the generated OpenAPI so the Phase 50 typed client gets a compile-time "asc" | "desc" string-literal union.

Available options:
asc,
desc
limit
integer
default:100
Required range: 1 <= x <= 500
skip
integer
default:0
Required range: x >= 0

Response

Successful Response

items
DispatchPauseResponse · object[]
required
limit
integer
required
skip
integer
required
total
integer | null
next_cursor
string | null