Conversations: Conversations List
gapify_list_conversationsList and filter customer-support conversations by status, labels, inbox, team, assignee, or search term, with pagination for browsing large result sets.
Instructions
List conversations with filters and pagination [Conversations]
GET /api/v1/accounts/{account_id}/conversations
Auth: User API key (header api-access-token).
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 |
|---|---|---|---|
| q | No | Query param. Filters conversations with messages containing the search term | |
| page | No | Query param. paginate through conversations Example: 1 | |
| labels | No | Query param. Label names to filter by, comma-separated. | |
| status | No | Query param. Filter by conversation status. One of: `open`, `resolved`, `pending`, `snoozed` Example: open | |
| team_id | No | Query param. Numeric ID of the team. | |
| inbox_id | No | Query param. Numeric ID of the inbox. | |
| account_id | Yes | The numeric ID of the account | |
| assignee_type | No | Query param. Filter conversations by assignee type. One of: `me`, `unassigned`, `all`, `assigned` Example: all |