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 Recipients

AI-generated

Summary

Lists the recipients attached to a Kapso broadcast campaign, returning either every recipient or a single page of results.

Inputs

  • Broadcast (required) — The broadcast campaign to read recipients from. Pick from a searchable list of recent broadcasts, or enter its UUID with the By ID mode (UUID format is validated).
  • Return All — When on, fetches all recipients across pages. Defaults to off.
  • Page — Page number to fetch (minimum 1, default 1). Shown only when Return All is off.
  • Per Page — Number of recipients per request (1–100, default 20). Shown only when Return All is off.

Output shape

A list of recipient records for the chosen broadcast, returned as n8n items.

The exact fields in each recipient record come from the Kapso API response and aren't defined in the node source shown. With Return All off, only the requested page is returned and you must increment Page to get more. With Return All on, the Page and Per Page inputs are hidden.

Examples

Example 1: Audit every recipient of a finished campaign

Select the broadcast from the list, turn Return All on.

Example 2: Preview the first few recipients of a draft broadcast

Broadcast by ID, Return All off, Page 1, Per Page 10.

Links

Discussion