Skip to content

List Conversations

List and filter conversations by date range, checkout state, workflow, and response status. Returns conversation summaries with customer info and the latest message.

NameTypeRequiredDescriptionDefault
fromstringNoStart date in ISO format (e.g., 2024-01-01T00:00:00Z)
tostringNoEnd date in ISO format (e.g., 2024-01-31T23:59:59Z)
checkoutStatestring[]NoFilter by checkout state(s): abandoned, recovered, messaged, initial, filtered, skipped, complete
workflowIdstringNoFilter by workflow ID (get IDs from list_workflows)
hasResponsebooleanNoOnly return conversations where the customer replied
limitnumberNoMax results per page (1–50)20
offsetnumberNoPagination offset0
Show me recovered conversations from this week
{
"conversations": [
{
"id": "conv-789",
"createdAt": "2025-01-28T14:30:00Z",
"customer": {
"name": "John Smith",
"phone": "+15559876543"
},
"workflowName": "Abandoned Cart - Main",
"checkoutState": "recovered",
"lastMessage": {
"body": "Thanks! Just completed my order 🎉",
"direction": "inbound",
"createdAt": "2025-01-28T15:10:00Z"
}
}
],
"totalCount": 42,
"limit": 20,
"offset": 0
}
  • Use checkoutState to filter by outcome — recovered for successful recoveries, abandoned for lost carts
  • Combine workflowId with date filters to analyze a specific flow’s conversations
  • For topic-based searching (e.g., “conversations about shipping”), use conversation-search instead
  • Use get_conversation_details to read the full thread of any conversation