Skip to main content
GET
List deliveries

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Path Parameters

endpointId
string
required

Webhook endpoint id (ep_...).

Example:

"ep_2nJ4qKZr8C1tY0dXwV3uFh7bM9s"

Query Parameters

limit
integer
default:20

Page size, 1-100. Out-of-range values are clamped and the effective value is echoed in pagination.limit.

Example:

20

cursor
string

Opaque cursor from a previous page's pagination.next. Pass it back unchanged. A cursor this API cannot use is rejected with 400 PAGINATION.INVALID_CURSOR.

status
enum<string>

Only deliveries with this final outcome. failed excludes deliveries that are still retrying.

Available options:
succeeded,
failed
eventType
string

Comma-separated event types to include.

Example:

"call.ended,call.started"

since
string<date-time>

Only deliveries created after this time (RFC 3339).

until
string<date-time>

Only deliveries created before this time (RFC 3339). Must be later than since.

Response

One page of deliveries.

data
object[]
required
pagination
object
required
requestId
string
required