Forms

Objects

FormSubmissionField

A submitted form field value

Fields

• associated_field_key (String) — The key of the associated customer field, if any
• field_value (FormSubmissionFieldValue) — The submitted value
• key (String!) — The field key that connects the definition to the submission value. Note: this is likely not useful to the user, but it may be useful as a unique identifier used by the client.
• label (String!) — The human-readable field label
• type (FormFieldType!) — The configured type of this field

FormSubmissionFieldAbsoluteDateValue

A FormSubmissionFieldAbsoluteDateValue

Fields

• absolute_date (DateTime!)
• time_zone (String)

FormSubmissionFieldCheckboxValue

A FormSubmissionFieldCheckboxValue

Fields

• boolean (Boolean!)

FormSubmissionFieldLocationValue

A FormSubmissionFieldLocationValue

Fields

• location (Address!)

FormSubmissionFieldNumberValue

A FormSubmissionFieldNumberValue

Fields

• number (Decimal!)

FormSubmissionFieldRecurringDateValue

A FormSubmissionFieldRecurringDateValue

Fields

• recurring_date (PartialLocalDate!)

FormSubmissionFieldSelectValue

A FormSubmissionFieldSelectValue

Fields

• labels ([String!]!)
• select ([String!]!)

FormSubmissionFieldTextValue

A FormSubmissionFieldTextValue

Fields

• text (String!)

FormSubmissionPayloadWithDefinition

A form submission's payload enriched with the labels from the form definition

Fields

• fields ([FormSubmissionField!]!) — The form fields with values and labels
• form_title (String!) — The title of the form
• id (ID!) — The form submission ID
• submitted_at (DateTime!) — When the form was submitted

Unions

FormSubmissionFieldValue

Possible types

• FormSubmissionFieldAbsoluteDateValue
• FormSubmissionFieldCheckboxValue
• FormSubmissionFieldLocationValue
• FormSubmissionFieldNumberValue
• FormSubmissionFieldRecurringDateValue
• FormSubmissionFieldSelectValue
• FormSubmissionFieldTextValue

Enums

FormFieldType

The type of form field

Values

• ABSOLUTE_DATE
• CHECKBOX
• CONSENT
• EMAIL_ADDRESS
• FIRST_NAME
• LAST_NAME
• LOCATION
• NUMBER
• PHONE_NUMBER
• RECURRING_DATE
• SELECT
• TEXT
• TEXTAREA
• URL