Skip to main content
GET
List outbound 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

project_id
string
required

Project id (UUID) belonging to the caller workspace.

Query Parameters

status
string

Only these statuses: one or more of queued, delivered, failed, dead, comma-separated. Anything else is a 400.

Example:

"failed,dead"

destination_id
string

Only deliveries to this destination.

since
string<date-time>

Only deliveries created at or after this ISO 8601 time. Anything that is not a timestamp is a 400.

until
string<date-time>

Only deliveries created at or before this ISO 8601 time.

limit
integer

Page size (default 25, max 100). Giving limit or offset turns paging on; without either the answer is the 500 newest, as before.

Required range: 1 <= x <= 100
offset
integer

Rows to skip, newest first.

Required range: x >= 0

Response

The project's deliveries, newest first, joined to their destination for name and URL, optionally filtered by status and destination. With limit/offset the list is paged and total counts every match; without them it is the 500 newest. The stored response body is deliberately omitted here - fetch one delivery for it.

deliveries
object[]
required
total
integer

Deliveries matching the filters, across all pages.

limit
integer
offset
integer