List responses of a WhatsApp Flow

const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}}; fetch('https://api.vambe.me/api/public/whatsapp-flows/{flowId}/responses', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));

{ "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 }

Headers

x-api-key

string

required

API key needed to authorize the request. The key role must include the templates read permission.

Path Parameters

flowId

string

required

ID of the WhatsApp Flow

Example:

"df980fc8-b6db-4820-bf22-2969482d106d"

Query Parameters

dateFrom

string<date-time>

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.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Example:

"2026-06-01T00:00:00.000Z"

dateTo

string<date-time>

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.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Example:

"2026-07-01T00:00:00.000Z"

page

number

Page number, starting at 1

Required range: 1 <= x <= 9007199254740991

Example:

1

pageSize

number

Number of responses per page (1-200)

Required range: 1 <= x <= 200

Example:

50

Response

Flow responses retrieved successfully.

items

object[]

Show child attributes

page

number

Example:

1

pageSize

number

Example:

50

total

number

Example:

120

totalPages

number

Example:

3

hasNextPage

boolean

Example:

true