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.

Contact → List

AI-generated

Summary

List Kapso contacts, optionally filtering by cursor, customer, business-scoped user ID, creation time, profile name, or WhatsApp ID. Choose whether to fetch all pages or limit results per request.

Inputs

  • Return All — Defaults to false. When false, Per Page sets the request size (1–100, default 20); when true, the operation requests all available pages.
  • Per Page — Request size when Return All is false; defaults to 20 and is limited to 100.
  • Additional Options — Optional filters: after or before cursor, business-scoped user ID, created after or before timestamps, customer external ID or UUID, whether a customer is associated, partial profile-name match, and partial WhatsApp ID match. Use response paging cursors to continue from a page.

Output shape

A list of contact records

Pagination behavior depends on Return All. With it disabled, the result is limited to one request; with it enabled, the operation retrieves all pages.

Links

Discussion