Retrieve forms
GET
https://www.rapidoform.com/be/api/surveys/:page?/:status?
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 |
|---|---|---|
| page | path number | Optional, one-based. When present, returns up to 10 forms per page; omitting it returns all matching forms. |
| status | path string | Optional. all (default), draft, or a non-draft filter such as published. Any value other than all or draft selects Collecting, Completed and Stopped together. |
| workspaceId | query string | Optional workspace ObjectId. Requires workspace membership; defaults to your workspace. |
Filters and pagination belong in the path: /api/surveys/2/draft. totalSurveys counts all matches, not just this page.
Example request
curl --request GET 'https://www.rapidoform.com/be/api/surveys/1/all' \
--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": [
{
"surveys": [
{
"_id": 12345,
"SurveyName": "Customer feedback",
"status": "Draft"
}
],
"totalSurveys": 1
}
],
"ErrorCode": "SUCCESS",
"fieldErrors": {
"List": []
}
}
HTTP 200 alone does not indicate success. Check ErrorCode and Errors; see troubleshooting.