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.

Path Parameters

pid
string
required

Project id (UUID) belonging to the caller workspace.

Body

application/json

All filters optional and ANDed. Note there is no until filter on this entity.

status
enum<string>

Matched exactly; any string is accepted by the handler.

Available options:
queued,
delivering,
delivered,
failed,
dead
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

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