Skip to main content
POST
Search deliveries

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Headers

Idempotency-Key
string

Makes a POST safe to retry for 24 hours: the same key, credential, path and body returns the stored response (Idempotent-Replayed: true) instead of running again. 422 if the key was used for a different request; 409 while the first is in flight.

Required string length: 1 - 255

Path Parameters

project_id
string
required

Project id (UUID) belonging to the caller workspace.

Body

application/json

All filters optional and ANDed. A blank response_code or min_latency_ms is ignored.

status

One status, or an array of statuses matched with IN ("failed" and "dead" together are everything that did not arrive). Matched exactly.

Available options:
queued,
delivering,
delivered,
failed,
dead,
paused,
cancelled
response_code
integer

Must be an integer.

destination_id
string
min_latency_ms
number

Matches response_ms >= value.

since
string

ISO timestamp; matches created_at >= since.

limit
integer
default:25
Required range: 1 <= x <= 200
offset
integer
default:0
Required range: x >= 0
until
string<date-time>

Upper bound on created_at (ISO 8601).

Response

One page of deliveries, newest first.

entity
string
required
Allowed value: "deliveries"
count
integer
required
total
integer
required
limit
integer
required
offset
integer
required
results
object[]
required