Deployments.ai Docs
Runtime

List channel deliveries

GET /v1/channel-deliveries · SDK listChannelDeliveries · CLI deployments channel-delivery list

GET
/v1/channel-deliveries

Requires channels:read.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Query Parameters

cursor?string

Opaque cursor returned by the previous page.

Length1 <= length <= 4096
limit?integer

Maximum number of resources to return.

Range1 <= value <= 100

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

ListChannelDeliveriesResponse

application/json
  1. response
channelDeliveries*array<>
nextCursor?|null
curl -X GET "https://example.com/v1/channel-deliveries"
{  "channelDeliveries": [    {      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "version": 0,      "environmentId": "string",      "organizationId": "string",      "projectId": "string",      "workspaceId": "string",      "attempts": 0,      "bindingId": "string",      "channel": "imessage",      "contentPreview": "string",      "externalThreadKey": "string",      "failedAt": "2019-08-24T14:15:22Z",      "id": "string",      "lastError": "string",      "object": "channel-delivery",      "provider": "aws_end_user_messaging_rcs",      "providerMessageId": "string",      "runId": "string",      "sentAt": "2019-08-24T14:15:22Z",      "status": "failed",      "threadId": "string"    }  ],  "nextCursor": "string"}