Download answers as Excel

GET

https://www.rapidoform.com/be/api/survey/dataformat2/:surveyId/:bookmark

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.

Parameters

NameType / locationDescription
surveyIdpath numberRequired form ID.
bookmarkpath booleanRequired true for answers whose respondent is bookmarked, false for all.

Success returns an Excel attachment, not the JSON envelope. Inspect Content-Type / Content-Disposition before treating the body as a file: errors (including No data found) may be HTTP 200 JSON. No pagination or date filter.

Example request

curl --request GET 'https://www.rapidoform.com/be/api/survey/dataformat2/12345/false' \
  --header "X-EMAIL: $RAPIDOFORM_EMAIL" \
  --header "X-API-KEY: $RAPIDOFORM_API_KEY" \
  --output responses.xlsx

Response

Success returns an Excel file. Error responses use JSON; check the response headers before saving the download.

HTTP 200 alone does not indicate success. Check ErrorCode and Errors; see troubleshooting.