Overview
The Forms API lets you read form definitions, retrieve and update submissions, and manage dropdown question options programmatically.
Available Endpoints
Forms
| Method | Endpoint | Description |
|---|---|---|
| GET | /forms/v1/forms | List forms for the account |
| GET | /forms/v1/forms/{formId} | Get a single form by ID |
Form Submissions
| Method | Endpoint | Description |
|---|---|---|
| GET | /forms/v1/forms/{formId}/form-submissions | List submissions for a form |
| GET | /forms/v1/forms/{formId}/form-submissions/{formSubmissionId} | Get a single submission |
| PUT | /forms/v1/forms/{formId}/form-submissions/{formSubmissionId} | Update a submission (manager fields only) |
Dropdown Questions
| Method | Endpoint | Description |
|---|---|---|
| GET | /forms/v1/forms/{formId}/questions/{questionId} | List dropdown options for a question |
| POST | /forms/v1/forms/{formId}/questions/{questionId} | Add dropdown options |
| PUT | /forms/v1/forms/{formId}/questions/{questionId}/options/{optionId} | Update a dropdown option |
| DELETE | /forms/v1/forms/{formId}/questions/{questionId}/options/{optionId} | Delete a dropdown option |
Authentication
All endpoints require an API key or OAuth 2.0.
| Scope | Operations |
|---|---|
| forms.read | GET forms, submissions, and dropdown options |
| forms.write | POST/PUT dropdown options; PUT form submissions |
| forms.delete | DELETE dropdown options |
Typical Workflow
- List forms — discover
formIdvalues (optionally filter by creation date). - Get form — load question structure and settings.
- Get submissions — pull submitted answers for a date range or specific users.
- Update submission — write manager-only fields when needed.
- Manage dropdown options — keep selectable values in sync with external systems.
NoteResults respect the authenticated admin's form permissions. You only see forms and submissions you are authorized to view.
Guide Pages
| Page | Description |
|---|---|
| Get Forms | List and retrieve form definitions |
| Form Submissions | Read and update submissions |
| Dropdown Options | Manage dropdown question values |
Updated 24 days ago
What’s Next
Did this page help you?
