Form Submissions
Stored records of every completed form submission. Submissions are produced automatically by POST /api/form/{id}; these endpoints are the read and prune surface for inspecting and cleaning historical data.
Scopes
| Scope | Reach |
|---|---|
form_submissions:read | Listing, reading, viewing filters. |
form_submissions:write | Deleting submission records. |
Endpoints
List Form Submissions
GET /api/form/history/
Returns a page of submission records.
Required scope: form_submissions:read · also accepts API key
Query parameters — standard pagination set; see Conventions › Pagination. Defaults: sort_by=created, sort_order=desc, hydrate=true.
Response 200 — FormSubmissionInDbCursorPage
Get Form Submission Filter Metadata
GET /api/form/history/filters
Returns filter/operator/sort options for List Form Submissions.
Required scope: form_submissions:read
Response 200 — open metadata object.
Get Form Submission by ID
GET /api/form/history/{id}
Returns a single submission record — the full payload of answers and file references.
Required scope: form_submissions:read · also accepts API key
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Submission ID. |
Response 200 — FormSubmissionRead
Delete Form Submission by ID
DELETE /api/form/history/{id}
Permanently removes a submission record. Note that any Factory assemblies that consumed this submission are not affected — only the submission record itself is removed.
Required scope: form_submissions:write
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Submission ID. |
Response 204 — empty.
WARNING
Deletion is irreversible and may be subject to your tenant's data-retention policy.
See also
- Form Viewer › Submit Form — the endpoint that creates submissions.
- Factory › Tickets — submissions often trigger downstream workflow runs.