Kapso API icon

Kapso API

Send WhatsApp messages, templates, flows, media, contacts, broadcasts, and inbox records through Kapso. Choose a resource, then follow each operation setup hints.

Broadcast → List

AI-generated

Summary

Lists WhatsApp broadcasts from Kapso, with optional filters for status, creation date range, and phone number. Returns either all broadcasts or a single page.

Inputs

  • Phone Number Name or ID — Connected Kapso WhatsApp number, chosen from a loaded list or set by expression. It is shown for this operation, but the broadcast filter is the separate Filter Phone Number ID option.
  • Return All — If true, fetches every matching broadcast across pages. If false, uses Page and Per Page.
  • Page — Page number (minimum 1, default 1). Shown only when Return All is off.
  • Per Page — Results per request (1–100, default 20). Sent as Kapso per_page for broadcast lists. Shown only when Return All is off.
  • Additional Options > Status — Filter by broadcast status: Any (no filter), Draft, Sending, Completed, or Failed.
  • Additional Options > Created After — Includes broadcasts created on or after this ISO 8601 time.
  • Additional Options > Created Before — Includes broadcasts created on or before this ISO 8601 time.
  • Additional Options > Filter Phone Number ID — Kapso phone number UUID used to restrict broadcasts. The value must be a valid UUID.

Output shape

A list of n8n items, each holding a broadcast record from the Kapso API.

The exact broadcast fields come from the Kapso API response and are not defined in the node source shown. With Return All off, only the requested page is returned. With Return All on, the node follows pagination to collect all results. Filter values are validated before the request, and an invalid UUID raises an error.

Examples

Example 1: Find broadcasts that are still being sent

Return All off, Per Page 50, Additional Options > Status = Sending.

Example 2: Export every broadcast created this month

Return All on, Created After set to the first day of the month (ISO 8601).

Example 3: List failed broadcasts for one phone number

Status = Failed, Filter Phone Number ID set to the Kapso phone number UUID.

Links

Discussion