Conversations: Conversations Filter
gapify_filter_conversationsFilter and paginate customer-support conversations using custom conditions to locate specific tickets by status, language, or other attributes.
Instructions
Filter conversations with custom filter options and pagination [Conversations]
POST /api/v1/accounts/{account_id}/conversations/filter
Auth: User API key or Agent bot API key (header api-access-token).
Body fields: payload. Extra fields can be passed via extra_body.
Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Query param. Page number, starting at 1. | |
| payload | No | Array of filter conditions. Each item: {attribute_key, filter_operator (e.g. equal_to, not_equal_to, contains, does_not_contain), values: [...], query_operator: "AND" | "OR", null on the last item}. Values may be Persian text. Example: [{"attribute_key":"browser_language","filter_operator":"not_eq","values":["en"],"query_operator":"AND"},{"attribute_key":"status","filter_operator":"eq","values":["pending"],"query_operator":null}] | |
| account_id | Yes | The numeric ID of the account | |
| extra_body | No | Additional JSON body fields to merge into the request (for keys not listed above). |