Z-PRO icon

Z-PRO

Consome a API externa da Z-PRO (multiatendimento WhatsApp e outros canais)

Actions198

Contatos → Search Contacts

AI-generated

Summary

Searches contacts in Z-PRO by optional textual parameter, tag ID, and supports pagination parameters.

Inputs

  • Search Param — Optional textual search parameter to search in contact name, number, CPF, etc.
  • Page — Page number for paginated results, defaults to 1.
  • Limit — Maximum number of contacts returned per page, defaults to 40.
  • Tag ID — Optional tag ID to filter contacts by a specific tag.

Output shape

A paginated list of contacts matching the search criteria.

Supports optional pagination with page and limit parameters. If provided, the tag ID will filter results. Search param matches multiple fields like name, number, CPF. The response data is normalized from Z-PRO API format.

Examples

Example 1: Find contacts with name or number matching 'Maria' on page 2 with 20 results per page.

Search Param='Maria', Page=2, Limit=20

Example 2: Get first page of contacts associated with tag ID 10.

Tag ID=10, Page=1 (default), Limit=40 (default)

Links

Discussion