Chat icon

Chat

Interact with the Chat API

Actions253

Conversation → Filter

AI-generated

Summary

Filter conversations within a specified account and inbox based on custom JSON filter rules.

Inputs

  • accountId (required) — The account containing the conversations to filter.
  • inboxId (required) — The inbox containing the conversations to filter.
  • filterPayload (required) — JSON array of filter rules containing attribute_key, filter_operator, values, and query_operator.
  • filterPage — Page number for retrieving paginated filter results. Defaults to 1.

Output shape

a list of conversation records

Returns paginated conversation objects matching the criteria specified in the filter payload.

Examples

Example 1: Filter open conversations

Specify Account and Inbox, pass JSON array rule filtering by status 'open', and set Filter Page to 1.

Links

Discussion