Z-API WhatsApp icon

Z-API WhatsApp

Integration with Z-API (WhatsApp) organized by resources (messages, groups, chats, contacts, products, queue, instance, status, etc.).

Chat → List Chats

AI-generated

Summary

List chats

Inputs

None.

Output shape

Array of items where each item has a json property containing a chat object

Defaults to page 1 and pageSize 15; returns an empty array if no chats; supports pagination via optional query parameters if extended.

Examples

Example 1: Fetch first page of chats

resource: Chat, operation: listChats (no parameters required)

Example 2: Get next page of chats

resource: Chat, operation: listChats, add query parameters page:2 pageSize:20

Example 3: List all chats without pagination limit

resource: Chat, operation: listChats, customize pageSize as needed

Links

Discussion