SendKuy API
API Reference

List what a campaign is sending, per contact

A dispatch is the plan to send to one contact, not a message. message_id is null until the row has been processed.

Try it — GET /campaigns/{id}/dispatches

Kept for this tab only — it disappears when you close it, and it is never sent anywhere except as the Authorization header on the call below.

Authorization

bearerAuth campaigns:read
AuthorizationBearer <token>

Authorization: Bearer sk_live_.... Keys in the query string or the request body are refused — a URL is logged by every proxy it passes, and that is how customer keys leak.

A key carries scopes. A call outside them answers 403 with insufficient_scope and names the scope it wanted.

In: header

Scope: campaigns:read

Path Parameters

id*string

The prefixed id of the object.

Query Parameters

starting_after?string

The meta.next_cursor from the previous page.

limit?integer

Rows per page. Defaults to 20, capped at 100.

Range1 <= value <= 100

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET https://app.sendkuy.com/api/v1/campaigns/cmp_9cBe3A1H-SLhW5fONWZ32wb-IIio5Ts3/dispatches \  -H "Authorization: Bearer sk_live_YOUR_API_KEY"
{  "meta": {    "has_more": true,    "next_cursor": "string"  },  "data": [    {      "object": "campaign_dispatch",      "id": "cds_9cBe3A1H-SLhW5fONWZ32wb-IIio5Ts3",      "campaign_id": "string",      "contact_id": "string",      "message_id": "string",      "channel": "email",      "status": "pending",      "scheduled_at": "2019-08-24T14:15:22Z",      "sent_at": "2019-08-24T14:15:22Z",      "delivered_at": "2019-08-24T14:15:22Z",      "error": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}