Retrieve respondents
GET
https://www.rapidoform.com/be/api/respondents/:surveyId/:page?/:size?/:startDate?/:endDate?/:showBookmark?
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
| Name | Type / location | Description |
|---|---|---|
| surveyId | path number | Required form ID. |
| page, size | path number | Optional; defaults 1 and 10. Use positive integers. |
| startDate, endDate | path string | Optional YYYY-MM-DD dates. Defaults 1970-01-01 through today. End date includes the whole day. |
| showBookmark | path boolean | Optional true to select bookmarked respondents; false includes all. |
| firstName, lastName, email, age, gender, householdIncome | query | Optional exact-match demographic filters; age is numeric. |
| demographicInfoFilled | query boolean | true includes records with at least one non-empty demographic field. |
| sortBy | query string | new (default) or old. |
Fill earlier optional path positions before later ones. Pagination, dates and bookmark are path parameters, not query filters. Preview respondents are excluded. totalResponse is the total matching count. This endpoint does not filter exclusively for completed submissions.
Example request
curl --request GET 'https://www.rapidoform.com/be/api/respondents/12345/1/10/2026-01-01/2026-12-31/false' \
--header "X-EMAIL: $RAPIDOFORM_EMAIL" \
--header "X-API-KEY: $RAPIDOFORM_API_KEY"
Response
Examples show selected fields, not every stored property. Empty arrays are valid for list/report endpoints.
{
"Errors": [],
"Info": [],
"Data": [
{
"result": [],
"totalResponse": 0
}
],
"ErrorCode": "SUCCESS",
"fieldErrors": {
"List": []
}
}
HTTP 200 alone does not indicate success. Check ErrorCode and Errors; see troubleshooting.