list_chats
Retrieve group and direct message chats with metadata, including filtering by label, sorting, and recent messages.
Instructions
List group and DM chats with metadata, filtering and sorting options.
Args:
label: chat label/folder - "inbox", "archive", "all","favourite", "unread" (default "inbox")
sort_by: Sort order - "latest_message", "last_active" or "name" (default "latest_message")
limit: Maximum number of chats to return (default 25)
recent_messages_limit: Number of recent messages to include per chat (default 3, set to 0 to disable)
max_participants: Maximum number of participant names to list for group chats (default 5)
include_low_priority: Whether to include low priority chats in archive/all views (default False)
Returns:
List of Chat objects with metadata including platform, truncated recent
messages for context, participants, timestamps etc.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| label | No | inbox | |
| limit | No | ||
| sort_by | No | latest_message | |
| max_participants | No | ||
| include_low_priority | No | ||
| recent_messages_limit | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |