Skip to content
Broadcasts

List broadcasts

GET
/broadcasts
 
const url = 'https://api.kirimdev.com/v1/broadcasts?status=draft&created_after=2026-10-01T00%3A00%3A00.000Z&created_before=2026-11-01T00%3A00%3A00.000Z&limit=25&cursor=eyJpZCI6IjAxSFhZWkFCQ0RFRkdISktNTlBRUlNUVldYIiwidHMiOiIyMDI2LTA5LTEwVDA5OjAwOjAwLjAwMFoifQ';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

List broadcast campaigns across every team in the organization, newest first. Counters are campaign totals; fetch a single broadcast for the per-status breakdown (stats). Broadcasts are created and sent from the dashboard.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
status

Filter by campaign status.

string
Allowed values: draft scheduled running completed failed cancelled
Example 
completed

Filter by campaign status.

created_after

Return broadcasts created strictly after this ISO 8601 instant.

string format: date-time
Example 
2026-10-01T00:00:00.000Z

Return broadcasts created strictly after this ISO 8601 instant.

created_before

Return broadcasts created strictly before this ISO 8601 instant.

string format: date-time
Example 
2026-11-01T00:00:00.000Z

Return broadcasts created strictly before this ISO 8601 instant.

limit

Number of items to return. Defaults to 25; minimum 1 and maximum 100.

string
default: 25 /^\d+$/
Example 
25

Number of items to return. Defaults to 25; minimum 1 and maximum 100.

cursor

Opaque continuation token from the previous response’s next_cursor. Pass it unchanged and keep all other filters the same.

string
>= 1 characters
Example 
eyJpZCI6IjAxSFhZWkFCQ0RFRkdISktNTlBRUlNUVldYIiwidHMiOiIyMDI2LTA5LTEwVDA5OjAwOjAwLjAwMFoifQ

Opaque continuation token from the previous response’s next_cursor. Pass it unchanged and keep all other filters the same.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Broadcast list

Media type application/json
object
data
required

Items in this page, ordered as documented by the operation.

Array<object>
object
id
required
string
object
required
string
Allowed values: broadcast
name
required
string
status
required
string
Allowed values: draft scheduled running completed failed cancelled
team_id
required
string
template
required

Template the campaign sent. null when the template has since been deleted.

object
id
required
string
name
required
string | null
language
required
string | null
whatsapp_account
required
object
phone_number
required
string | null
phone_number_id
required

Meta business_phone_number_id — use as the {phone_number_id} path segment in /v1/{phone_number_id}/... endpoints.

string | null
customer
required

End-customer (multi-tenant platform mode) that owns this account. NULL for direct-org accounts.

object
id
required
string
name
required
string
scheduled_at
required
string | null format: date-time
failure_reason
required

Why the whole campaign stopped (for example an audience larger than the remaining quota). Per-recipient failures are on the recipients instead.

string | null
total_count
required

Recipients in the audience.

integer
sent_count
required

Recipients Meta accepted (includes those since delivered or read).

integer
failed_count
required
integer
created_at
required
string format: date-time
updated_at
required
string format: date-time
has_more
required

Whether another page is available.

boolean
next_cursor
required

Pass this value unchanged as cursor to fetch the next page. null marks the final page.

string | null
request_id
required

Unique request identifier to include when contacting support.

string
Example 
{
  "data": [
    {
      "id": "bcst_01HXYZABCDEFGHJKMNPQRSTVWX",
      "object": "broadcast",
      "name": "Promo Oktober",
      "status": "draft",
      "template": {
        "id": "tmpl_01HXYZABCDEFGHJKMNPQRSTVWX"
      },
      "whatsapp_account": {
        "phone_number_id": "106540352242922",
        "customer": {
          "id": "cus_01HXYZABCDEFGHJKMNPQRSTVWX"
        }
      }
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}

400

Section titled “400 ”

Validation failure

Media type application/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error
code
required
string
message
required

Human-readable explanation of the error.

string
param

Request field associated with the error, when applicable.

string
request_id
required

Unique request identifier to include when contacting support.

string
Examples
Example default

A field value is invalid.

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_field_value",
    "message": "A field value is invalid.",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

401

Section titled “401 ”

Authentication failure

Media type application/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error
code
required
string
message
required

Human-readable explanation of the error.

string
param

Request field associated with the error, when applicable.

string
request_id
required

Unique request identifier to include when contacting support.

string
Examples
Example default

The provided API key is invalid.

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "The provided API key is invalid.",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

429

Section titled “429 ”

Rate limit exceeded

Media type application/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error
code
required
string
message
required

Human-readable explanation of the error.

string
param

Request field associated with the error, when applicable.

string
request_id
required

Unique request identifier to include when contacting support.

string
Examples
Example default

Rate limit exceeded.

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded.",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

500

Section titled “500 ”

Internal server error

Media type application/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error
code
required
string
message
required

Human-readable explanation of the error.

string
param

Request field associated with the error, when applicable.

string
request_id
required

Unique request identifier to include when contacting support.

string
Examples
Example default

An unexpected error occurred.

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred.",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}