Walytic icon

Walytic

Interact with the Walytic WhatsApp automation platform

Contact → List

AI-generated

Summary

List contacts matching optional filters such as lead status, stage, source, tag, search terms (name, phone, email), assigned flow ID, session ID, pagination page, and limit.

Inputs

  • Filters — Collection of optional filters to narrow down the contacts returned. Includes:
  • Is Lead (boolean) to filter by lead status.
  • Stage (options: new, contacted, qualified, converted, lost) to filter by contact pipeline stage.
  • Source (string) to filter by contact source.
  • Tag (string) to filter by contact tag.
  • Search (string) to search by name, phone, or email.
  • Assigned Flow ID (string) to filter contacts assigned to a specific automation flow.
  • Session ID (string) to filter contacts by WhatsApp session.
  • Page (number) the pagination page number, default 1.
  • Limit (number) maximum contacts to retrieve per page, default 50.

Output shape

a list of contact objects

Returns an array of contacts under the 'contacts' property in the API response; outputs each contact as a separate item in the node's output. Supports pagination via 'page' and 'limit' filter inputs.

Examples

Example 1: List all contacts marked as leads in 'qualified' stage with a specific tag

Set Filters: Is Lead = true, Stage = 'qualified', Tag = yourtag, Limit = 100

Example 2: Search contacts by email or phone substring

Set Filters: Search = '', Limit = 50

Links

Discussion