list_chats
Read-onlyIdempotent
List Zendesk Chat conversations with pagination. Use cursor, fields, and filter parameters to refine results.
Instructions
List Zendesk Chat conversations as paginated items in their native shape (no skeleton projection, chat payloads are already compact). Default limit: 100; pass cursor, fields, or filter. Plan-gated, degrades to upstream_error on instances without the Chat add-on. Scope-gated when chats include user/ticket data (config_plus_audits or full).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max items to return. Default 100. The full corpus is fetched and cached server-side; this only limits what the response carries. | |
| cursor | No | Opaque pagination token from a previous response. Slices the next page from the cached corpus. Stale cursors (older than the cache TTL) auto-reset to offset 0 and set cursor_invalidated: true. | |
| fields | No | Whitelist of field names. Overrides the default projection. Use to opt into extra fields (e.g. ["id","title","active","position","category_id","updated_at"]) without going fully verbose. | |
| filter | No | Structured filter applied to the cached corpus before slicing. Supported keys: active (bool), category_id (number/string), title_contains (string, case-insensitive), updated_since (ISO timestamp). Unsupported keys are ignored with a note in the response. | |
| refresh | No | Bypass cache and re-fetch from Zendesk | |
| instance | No | Override the sticky instance for this call |