Skip to main content
GET
Get all data fields

Authorizations

Authorization
string
header
required

Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.

Response

id
number
required
label
string
required
name
string
required
target
enum<string>
required
Available options:
email,
firstname,
lastname,
fullname,
phone,
other
fieldType
enum<string>
required
Available options:
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
order
number
required

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.

locales
object[]
required
default
boolean
required
required
boolean
required
hidden
boolean
required
hideUntilChange
boolean
required
mutable
boolean
required
options
object[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
showInfobox
boolean
required

Only for data fields of type slide, enable to show an infobox.

companyId
string
required
useMarkdown
boolean
required

When true, field.label is rendered through markdown-it (html: false). Allows bold, italic, code, and links in field labels.

requireSignatureOtp
boolean
required

When true, the signer must verify their email via OTP before the signature canvas is unlocked.

defaultValue
string
placeholder
string
slideOptions
object
fileFieldOptions
object

Configuration for file upload fields. Only used when fieldType is 'file'.

contactOptions
object

Configuration for contact composite fields. Controls which sub-inputs (name, email, phone, address, etc.) are shown.

hubspotContactField
string
hubspotCompanyField
string
smartWeContactField
string
smartWeCompanyField
string
pipedriveContactField
string
closeContactField
string
salesforceContactField
string
salesforceLeadField
string
salesforceCaseField
string
salesforceOpportunityField
string
salesforceAccountField
string
deletedAt
string | null
helpText
string

Optional help text shown below the field in the booking form. Provides additional guidance to users filling out the form.

bankDetailsOptions
object

Configuration for bank details composite fields. Controls which optional sub-inputs (BIC, account holder, signature) are shown.

licensePlateOptions
object

Configuration for license plate fields. Controls country format validation.

pdfTemplateOptions
object

Configuration for PDF template fields. Holds the uploaded template PDF reference and pdfme schema JSON.

fileDownloadOptions
object

Configuration for file download display fields. Holds IDs of library files to offer for download.

displayStyle
object

Controls how options are displayed for radio/checkbox/select fields. 'default' - Standard list view 'card' - Card grid with optional icons

conditions
object | null

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.

headingLevel
number

Heading level for heading fields (1–6). Defaults to 2 (renders as

).

signingPaused
boolean

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.

infoboxText
string

Only for data fields of type slide, custom infobox text.

evalancheFieldId
string
klicktippFieldId
string
min
number

Currently used by number field as min value. For string field, it is minimum amount of characters.

max
number
style
number

For Phone Number field - used to set the style of phone input. 0 - Simple (Default) 1 - With country code picker

defaultCountryCode
string

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.