Kirim icon

Kirim

Send WhatsApp messages and manage your inbox via the Kirimdev API

Contact → List

AI-generated

Summary

Lists contacts for a selected WhatsApp account, with optional filters and cursor-based pagination. Sends a GET request to that account’s contacts endpoint.

Inputs

  • From Account Name or ID (required) — WhatsApp account that owns the contacts; select an account or provide its ID.
  • Phone — Filter by an exact E.164 phone number.
  • BSUID — Filter by an exact Business-Scoped User ID.
  • Username — Filter by an exact WhatsApp username; matching is case-insensitive, and periods and underscores are significant.
  • Search — Case-insensitive substring match against contact name and email.
  • Limit — Maximum number of results per request, from 1 to 100; defaults to 50.
  • Cursor — Pagination cursor for requesting another page.

Output shape

A list of contact records.

Optional filters are sent as query parameters when provided. Use the cursor to paginate; the operation does not indicate automatic pagination.

Links

Discussion