Get all data fields
Authorizations
Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.
Response
email, firstname, lastname, fullname, phone, other email, phone, text-single, text-multi, number, select, checkbox-single, checkbox-multi, radio, slide, url, file, date-of-birth, yes-no, rating, scale, signature, date, time, image, heading, separator, page-break, contact, bank-details, license-plate, info-text, info-image, info-video, currency, location, pdf-template, file-download Where this field sits when its values are read back on a record.
A contact's custom fields are a jsonb bag keyed by field name, so the card
showing them had no order but the one values happened to be written in —
which put a postcode above the street it belongs under. Ordering the
definitions gives every surface reading additionalData one answer.
Lower first; ties fall back to id, so untouched companies keep the order
they already see.
Only for data fields of type slide, enable to show an infobox.
When true, field.label is rendered through markdown-it (html: false).
Allows bold, italic, code, and links in field labels.
When true, the signer must verify their email via OTP before the signature canvas is unlocked.
Configuration for file upload fields. Only used when fieldType is 'file'.
Configuration for contact composite fields. Controls which sub-inputs (name, email, phone, address, etc.) are shown.
Optional help text shown below the field in the booking form. Provides additional guidance to users filling out the form.
Configuration for bank details composite fields. Controls which optional sub-inputs (BIC, account holder, signature) are shown.
Configuration for license plate fields. Controls country format validation.
Configuration for PDF template fields. Holds the uploaded template PDF reference and pdfme schema JSON.
Configuration for file download display fields. Holds IDs of library files to offer for download.
Controls how options are displayed for radio/checkbox/select fields. 'default' - Standard list view 'card' - Card grid with optional icons
Conditional visibility expression. When set, the field is only shown to the visitor when the expression evaluates to true against current form values. Uses the same Expression/ExpressionCondition structure as routing rules.
Heading level for heading fields (1–6). Defaults to 2 (renders as
).
Computed per request when a public form is served — not persisted.
Populated by PublicFormController.withSigningAvailability.
True when the owning company has used this month's signature allowance, so the renderer shows this field as temporarily unable to take a signature instead of a signature pad. The rest of the form still renders and still submits: these forms are lead capture, and losing the lead would cost the owner far more than the unsigned document.
Only for data fields of type slide, custom infobox text.
Currently used by number field as min value. For string field, it is minimum amount of characters.
For Phone Number field - used to set the style of phone input. 0 - Simple (Default) 1 - With country code picker
For Phone Number field - default country code (e.g., "+1", "+49", "+44"). Used when style is WITH_COUNTRY_CODE_PICKER to set the initial country selection.