Path parameters
string
required
The location.
Query parameters
string
Restrict to one or more visit type ids.
string
default:"en"
Language for the labels.
boolean
default:"false"
true gives a custom field defined by several visit types one entry per visit type instead of one merged entry.Response
string
The key you send and read. Answers are stored on the visit under this name.
string
The label as the visitor sees it.
string
The label as the Backoffice column is headed — includes the visit type name for a split column.
string
text, number, list, check, yes_no or datetime.string
required, optional, hidden or disabled — as enforced in the front office, not by this API.array
For
list fields, the allowed values.object
A regular expression and a message, applied in the front office.
string
Present on split columns — which visit type this variant belongs to.
A custom field’s value is stored under its
field_name, so two visit types defining a field with the same name share one key on the visit. split_by_visit_type=true is how the Backoffice grid tells those apart; for an integration the merged view is usually what you want.