Chat icon

Chat

Interact with the Chat API

Actions253

Conversation → List

AI-generated

Summary

List conversations based on filter criteria

Inputs

  • accountId (required) — Select the account to use.
  • inboxId (required) — Select the inbox to use.
  • filters — Add Filter containing assignee_type, labels, page, q, status, or team_id.
  • page — Page number for pagination.
  • q — Filter conversations with messages containing this search term.
  • status — Filter conversations with messages containing this search term.
  • team_id — Filter by team. Choose from the list, or specify an ID using an expression.

Output shape

a list of conversation objects

Pagination may include additional metadata; fields can be optional depending on response.

Examples

Example 1: List open conversations in a specific inbox

accountId=123, inboxId=456, filters={status:'open'}, page=1

Links

Discussion