campaigns

List campaigns

Fetch campaign status, counters, filters and cursor pagination.

Filter by status or channel for operational dashboards.

channel is whatsapp, sms or email. telegram answers 400 validation_failed (details.field channel): Telegram is not a channel customers can use.

get/api/v1/campaigns

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/campaigns
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of items to return.

cursorstring

Opaque pagination cursor. Pass the next_cursor from a previous response; do not construct it yourself.

Response

Success

next_cursorstring nullable required
has_moreboolean required
request_idstring required

Example response

{
  "data": [
    {
      "id": "8701a57c-11df-4a63-a950-0f22206d6bdf",
      "name": "Launch announcement",
      "status": "active_in_progress",
      "counts": {
        "sent": 240,
        "delivered": 198,
        "failed": 3
      }
    }
  ],
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.