Retrieve a form

GET

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

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 numeric form ID.

Example request

curl --request GET 'https://www.rapidoform.com/be/api/survey/12345' \
  --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": [
    {
      "survey": {
        "_id": 12345,
        "SurveyName": "Customer feedback",
        "status": "Draft"
      }
    }
  ],
  "ErrorCode": "SUCCESS",
  "fieldErrors": {
    "List": []
  }
}

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