Search Conversations
conversations_search_conversationRead-onlyIdempotent
Search conversations with filters for status, contact, assignee, date range, and message type to locate specific CRM records.
Instructions
Search Conversations Returns a list of all conversations matching the search criteria along with the sort and filter options selected. [GET /conversations/search] Scopes: conversations.readonly.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Id of the conversation | |
| sort | No | Sort paramater - asc or desc | |
| limit | No | Limit of conversations - Default is 20 | |
| query | No | Search paramater as a string | |
| sortBy | No | The sorting of the conversation to be filtered as - manual messages or all messages | |
| status | No | The status of the conversation to be filtered - all, read, unread, starred | |
| endDate | No | End date filter for dateAdded field (Unix timestamp in milliseconds) | |
| mentions | No | User Id of the mention. Multiple values are comma separated. | |
| contactId | No | Contact Id | |
| followers | No | User IDs of followers to filter conversations by. Multiple IDs can be provided as comma-separated values. | |
| startDate | No | Start date filter for dateAdded field (Unix timestamp in milliseconds) | |
| assignedTo | No | User IDs that conversations are assigned to. Multiple IDs can be provided as comma-separated values. Use "unassigned" to fetch conversations not assigned to any user. | |
| locationId | Yes | Location Id | |
| scoreProfile | No | Id of score profile on which conversations should get filtered out, works with scoreProfileMin & scoreProfileMax | |
| startAfterDate | No | Search to begin after the specified date - should contain the sort value of the last document | |
| lastMessageType | No | Type of the last message in the conversation as a string | |
| scoreProfileMax | No | Maximum value for score | |
| scoreProfileMin | No | Minimum value for score | |
| sortScoreProfile | No | Id of score profile on which sortBy.ScoreProfile should sort on | |
| lastMessageAction | No | Action of the last outbound message in the conversation as string. | |
| lastMessageDirection | No | Direction of the last message in the conversation as string. |