List conversations
Changed onReturns a paginated list of conversations grouped by contact phone number, sorted by most recent activity. Listing by inbox_id or with pinned can return 400 FEATURE_NOT_SUPPORTED (with param naming which one), 400 CONTACT_FILTER_NOT_SUPPORTED when the inbox has saved contact filters on a workspace still on the old contact model, or 422 CONTACT_FILTER_TOO_LARGE (type validation_error) when its contact filters resolve to too many numbers or hold more than 50 IDs. Right after an inbox is created, INBOX_NOT_FOUND can be transient and carries retryable: true: retry once.
Request
- Base URLhttps://api.withallo.com
- URLhttps://api.withallo.com/v2/api/conversations
- AuthAPI key in header Authorization
Query parameters
Filter by Allo number (E.164). Send exactly one of allo_number or inbox_id. List your numbers with GET /v2/api/numbers to find the right one.
List the conversations of one of your inboxes (inb-*), from all of its lines (each row has its own allo_number). The inbox's sources and saved filters apply, but not the app's Needs action and Mine tabs; pass unread yourself. Send exactly one of allo_number or inbox_id.
Only return conversations with activity after this timestamp (ISO 8601). Ideal for incremental sync.
Only pinned (true) or only unpinned (false) conversations. Any other value returns 400 INVALID_PARAMETER.
Page number (1-indexed)
Results per page
Comma-separated optional fields. Supported: transcript
Response
List of conversations
Example response
{
"data": [
{
"contact_number": "+14155551234",
"contacts": [
{
"id": "cnt-abc123",
"name": "Sarah Johnson",
"company": {
"id": "com-xyz789",
"name": "Acme Corp"
},
"deals": [
{
"id": "dea-def456",
"name": "Enterprise Plan"
}
]
}
],
"last_item": {
"id": "cll-abc123",
"allo_number": "+14155550100",
"contact_number": "+14155551234",
"contacts": [
{
"id": "cnt-abc123",
"name": "Sarah Johnson",
"company": {
"id": "com-xyz789",
"name": "Acme Corp"
},
"deals": [
{
"id": "dea-def456",
"name": "Enterprise Plan"
}
]
}
],
"user": {
"id": "usr-abc123",
"name": "John",
"email": "john@acme.com"
},
"extracted_data": {
"contact": {
"name": "Marie Dupont",
"company": "Vibrant Events",
"job_title": "Office manager",
"website": "vibrantevents.com",
"address": "12 rue de la Paix, Paris",
"emails": [
"marie@vibrantevents.com"
]
}
}
},
"allo_number": "+14155550100"
}
]
}Changes
- warning
added the new
BLOCKEDenum value to the////response property for the response status - warning
added the new
CLOSEDenum value to the////response property for the response status - warning
added the new
FAILEDenum value to the////response property for the response status - warning
added the new
FAILED_EXTERNALenum value to the////response property for the response status - warning
added the new
RECEIVEDenum value to the////response property for the response status - warning
added the new
TRANSFERRED_AIenum value to the////response property for the response status - warning
added the new
TRANSFERRED_EXTERNALenum value to the////response property for the response status - info
added the new optional
queryrequest parameterinbox_id - info
added the new optional
queryrequest parameterpinned - info
the
queryrequest parameterallo_numberbecame optional - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the optional property
///to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
removed the
TRANSFERREDenum value from the////response property for the response status - info
added the required property
///to the response with the status
- warning