Overview

The Forms API lets you read form definitions, retrieve and update submissions, and manage dropdown question options programmatically.

Available Endpoints

Forms

MethodEndpointDescription
GET/forms/v1/formsList forms for the account
GET/forms/v1/forms/{formId}Get a single form by ID

Form Submissions

MethodEndpointDescription
GET/forms/v1/forms/{formId}/form-submissionsList 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

MethodEndpointDescription
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.

ScopeOperations
forms.readGET forms, submissions, and dropdown options
forms.writePOST/PUT dropdown options; PUT form submissions
forms.deleteDELETE dropdown options

Typical Workflow

  1. List forms — discover formId values (optionally filter by creation date).
  2. Get form — load question structure and settings.
  3. Get submissions — pull submitted answers for a date range or specific users.
  4. Update submission — write manager-only fields when needed.
  5. Manage dropdown options — keep selectable values in sync with external systems.
📝

Note

Results respect the authenticated admin's form permissions. You only see forms and submissions you are authorized to view.


Guide Pages

PageDescription
Get FormsList and retrieve form definitions
Form SubmissionsRead and update submissions
Dropdown OptionsManage dropdown question values

API Reference