v1
latestOpenAPI 3.0.02026-07-2612645160.3 KBList responses of a WhatsApp Flow
Retrieve the completed responses of a WhatsApp Flow, filtered by response date (dateFrom/dateTo). When no dates are provided, it defaults to the last 30 days; when only one date is provided, the other bound is left open. Results are ordered by response date descending and paginated with page/pageSize. Note: responded_at reflects the last time the response was updated — normally when the contact completed the flow, but it can move forward if the response is reprocessed internally (e.g. a media retry), in which case the response reappears in a later date window.
Path parameters
ID of the WhatsApp Flow
Query parameters
Return only responses whose response date (responded_at) is at or after this timestamp. Must be a full ISO 8601 datetime including timezone, e.g. 2026-06-01T00:00:00Z or 2026-06-01T00:00:00-04:00 (date-only values like 2026-06-01 are rejected). Defaults to 30 days ago when neither dateFrom nor dateTo is provided; if dateTo is provided without dateFrom, no lower bound is applied.
Return only responses whose response date (responded_at) is at or before this timestamp. Must be a full ISO 8601 datetime including timezone, e.g. 2026-07-01T00:00:00Z. If omitted, no upper bound is applied.
Page number, starting at 1
Number of responses per page (1-200)
Headers
API key needed to authorize the request. The key role must include the templates read permission.
Response
Flow responses retrieved successfully.
Example response
{
"items": [
{
"id": "7c9b3f1a-2d4e-4f6a-8b0c-1d2e3f4a5b6c",
"form_data": {
"rating": "5",
"comment": "Great service"
},
"status": "completed",
"sent_at": "2026-06-15T10:00:00.000Z",
"responded_at": "2026-06-15T10:05:00.000Z",
"contact": {
"id": "df980fc8-b6db-4820-bf22-2969482d106d",
"name": "John Doe",
"phone": "+56912345678",
"email": "john@example.com"
}
}
],
"page": 1,
"pageSize": 50,
"total": 120,
"totalPages": 3,
"hasNextPage": true
}