Ricky logorickyDocs

List broadcasts

GET
/broadcasts

Newest first, with how many recipients are in each delivery status.

Scope: broadcasts:read.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key, rky_live_…, created in Settings → API. Send it only from a server.

page_size?integer

Items per page.

Range1 <= value <= 100
Default50
cursor?string

next_cursor from the previous page. Use it unchanged.

Lengthlength <= 2048

Response Body

Success.

application/json
  1. response
data*array<>
next_cursor*|

Pass as cursor for the next page; null on the last page.

curl -X GET 'https://getricky.ai/api/v1/broadcasts'
{  "data": [    {      "id": "0c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",      "channel_id": "8f3c2a5e-6b1d-4c7a-9e2f-1a2b3c4d5e6f",      "template": {        "id": "1234567890123456",        "name": "promo_octubre",        "language": "es"      },      "audience": {        "type": "filter",        "tag_id": "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f",        "lifecycle_stage": null,        "query": null      },      "status": "completed",      "counts": {        "recipients": 120,        "pending": 0,        "sent": 14,        "delivered": 61,        "read": 41,        "failed": 4      },      "scheduled_at": "2026-10-14T14:00:00.000Z",      "canceled_at": null,      "completed_at": "2026-10-14T14:03:12.000Z",      "created_by_user_id": "2d4f6a8c-1b3d-4e5f-8a7b-9c0d1e2f3a4b",      "created_at": "2026-10-14T15:30:00.000Z"    }  ],  "next_cursor": "string"}