Responses API
Read respondents, their answers, report graphs and exports on demand.
All requests require X-EMAIL and X-API-KEY. See authentication and errors. JSON request bodies also require Content-Type: application/json. All IDs in examples are synthetic; replace them with your own values.
Choose a response endpoint
Start with Retrieve respondents. Each record has a respondentsId used to retrieve its answers. The record’s MongoDB _id is a different identifier. To inspect one question across respondents, use Retrieve answers for a question.
Report access requires a form you own or a form in your workspace. Owner, Admin and Member accounts can read; invited and deactivated-member roles cannot authenticate through the API.
Pagination and filters
Pagination is one-based. Dates, page size and bookmark flags on report routes are path segments, not query parameters. Complete earlier path segments before supplying later ones. The respondents endpoint separately supports demographic and sort query filters.
Listing respondents excludes preview records but can include unfinished submissions. Answer shapes depend on question type. Do not assume every result is a completed submission or every answer is text.
Endpoints
Exports
The JSON export returns records directly in Data. The Excel route returns a file on success and can return a JSON error with HTTP 200 if no data exists. Both exports take a bookmark flag and have no date filter or pagination.