Types

OnboardingSessionForm

The form a respondent is on, with the answers so far.

session_idrequired
string (uuid)
The session the form belongs to.
form_idrequired
string (uuid)
The flow form the respondent is on.
submission_idrequired
string (uuid)
The record that holds the respondent's answers to this form. It is not readable through /submissions, which leaves flow forms out.
namerequired
string | null
The form's display name.
pagesrequired
object[]
The form's pages, in order.
fieldsrequired
object[]
The form's fields, in order.
answersrequired
object
The respondent's answers so far, keyed by form field id. A file answer reads as an object with uuid, name and size. A masked answer is withheld.
completed_atrequired
string | null (date-time)
When the respondent completed this form. Null while it is still open.
can_go_backrequired
boolean
Whether the session has moved on from the start form, so that step-back has somewhere to go.

Used by (1)