Types

FormSubmission

A form submission.

idrequired
string (uuid)
The submission id.
form_idrequired
string | null (uuid)
The form the submission answers. Set on create; it cannot change.
user_idrequired
string | null (uuid)
The user the submission belongs to. Set on create; it cannot change.
statusrequired
string
draft until the submission is completed, then completed. Read-only: POST /submissions/{id}/actions/complete completes it.One of: draft, completed
started_atrequired
string | null (date-time)
When the submission was started.
completed_atrequired
string | null (date-time)
When the submission was completed. Null while it is a draft.
answersrequired
object
The answers, keyed by form field id. A file answer reads as an object with uuid, name and size (name and size are null when the file is gone), and a masked answer reads as null.
documents
object[]
The documents generated from the submission, oldest first. Only with include=documents.
created_atrequired
string (date-time)
When the submission was created.
updated_atrequired
string | null (date-time)
When the submission last changed.

Used by (8)