Create API
Create and manage forms, questions, themes and uploaded images from your server.
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.
Build your first form
- Create a form and save its numeric ID.
- Create questions using that ID as a string in surveyId. A welcome question is created automatically at order 0.
- Optionally create a theme and assign its ID through Update a form.
- Review your form, then set its status to Collecting when it is ready for respondents.
Owner and Admin accounts can write unless marked read-only. Members can read. Account expiry, plan limits and individual endpoint checks can also reject requests. These APIs do not replace every builder feature; use the builder for complex question and logic configuration.
Endpoints
| Endpoint | Method |
|---|---|
| Create a form | POST |
| Retrieve forms | GET |
| Retrieve a form | GET |
| Update a form | PUT |
| Delete a form | DELETE |
| Create a question | POST |
| Retrieve form questions | GET |
| Retrieve a question | GET |
| Update a question | PUT |
| Delete a question | DELETE |
| Create a theme | POST |
| Retrieve workspace themes | GET |
| Retrieve gallery themes | GET |
| Retrieve a form theme | GET |
| Update a theme | PUT |
| Delete a theme | DELETE |
| Upload an image | POST |
| Delete an image | DELETE |
Download the Postman collection. Set the baseUrl, email and apiKey environment variables before sending a request. Keep credentials private and use disposable forms when testing updates or deletes.