Get started
Use RapidoForm’s form APIs from your server to manage forms, read answers and configure submission webhooks.
Requirements
- Sign in to RapidoForm.
- Open Settings → Admin Settings and copy your API key.
- Use the registered email belonging to that same key.
Keep the key in server environment variables. Never put it in browser JavaScript, mobile clients, public repositories or embed code. The public form embed does not need an API key.
Base URL
https://www.rapidoform.com/be
Append the endpoint path exactly as shown, including /api. For a local development backend, replace the base with http://localhost:8082/be after starting it with the protected development configuration.
Authentication
| Header | Required | Value |
|---|---|---|
| X-EMAIL | Yes | Registered email for the API key |
| X-API-KEY | Yes | Your account API key |
| Content-Type | For JSON bodies | application/json |
Set RAPIDOFORM_EMAIL and RAPIDOFORM_API_KEY securely in your shell before using the examples. The dollar-prefixed names below are shell environment variables.
curl 'https://www.rapidoform.com/be/api/surveys/1/all' \
--header "X-EMAIL: $RAPIDOFORM_EMAIL" \
--header "X-API-KEY: $RAPIDOFORM_API_KEY"
Roles and plans
| Account role | Read (GET) | Write (POST, PUT, DELETE) |
|---|---|---|
| Owner / Admin | Allowed by authentication | Allowed unless read-only |
| Member | Allowed by authentication | Denied (403) |
| Invited / Deactivated Member / other roles | Denied (403) | Denied (403) |
| Anonymous / invalid credentials | Denied (401) | Denied (401) |
Individual endpoints apply further form, workspace or creator checks. Plan and expiry checks are operation-specific; API authentication alone does not guarantee an operation will succeed. Free form creation is limited to three forms, publishing Free forms with payment/file-upload questions is rejected, and media storage limits apply.
Request and response format
Use GET to read, POST to create, PUT to update and DELETE to remove resources. Most requests and responses use JSON; image uploads use multipart/form-data and Excel exports return an attachment.
Form IDs are numeric, such as 12345. Question, theme and webhook IDs are ObjectId strings. Several bodies use the form ID as a string, such as "12345". Field names and capitalization matter: creation uses surveyName, while form updates use SurveyName.
A typical successful response has this envelope:
{
"Errors": [],
"Info": [],
"Data": [],
"ErrorCode": "SUCCESS",
"fieldErrors": { "List": [] }
}
The contents of Data depend on the endpoint. Examples show selected fields and synthetic IDs. Empty list results are valid. Some access-control errors omit Info or fieldErrors, so clients should not require those properties.
Troubleshooting
Always inspect ErrorCode and Errors as well as the HTTP status. Many validation, plan and not-found errors are HTTP 200 with ErrorCode: ERROR. Do not interpret every 200 response as success.
| HTTP status | What to check |
|---|---|
| 200 with ERROR | Validation errors, plan/expiry restrictions, missing resources, or no export data. Read Errors and fieldErrors.List. |
| 400 | Invalid resource selector, mismatched question parent, protected update fields, or missing multipart media. |
| 401 | Missing, empty or mismatched X-EMAIL and X-API-KEY. |
| 402 | Uploaded media would exceed your storage limit. |
| 403 | Current role, read-only restriction, report access or media ownership. |
| 404 | Missing question/theme, wrong route, or missing required path segments. |
Do not retry validation or permission errors unchanged. Correct the request first. For network failures, avoid blindly repeating POST requests: a resource may have been created before the connection failed.