Skip to main content
GET
Get a booking form field by ID

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The ID of the resource to query by

Response

Default Response

A booking form field definition — the type, label, options, and required-ness of a single question a booker is asked.

id
string
required

The unique identifier of the field. Stable across the forms a field is used on. Use this as the :id when looking the field up.

type
enum<string>
required

The type of a booking form field, determining how it is rendered and what answer it collects.

Available options:
TEXT,
TEXT_AREA,
EMAIL,
PHONE_NUMBER,
ADDRESS,
DATE,
DURATION,
SELECT,
GROUP_SELECT,
RADIO_BUTTONS,
CHECK_BOXES,
WAIVER,
CUSTOM_COMPONENT,
CHARITY_MARKETING_OPT_INS,
HTML
name
string
required

The default label of the field.

nameByLocale
object
required

Field label translated to multiple locales. Always includes the default name.

required
boolean
required

Whether an answer to this field is required to complete a booking.

publicId
string

A non-unique grouping key that correlates equivalent fields across forms and tickets. Informational only — not usable as a lookup :id.

description
string

The default description of the field, if any.

descriptionByLocale
object

Field description translated to multiple locales. Present only when the field has a description.

options
BookingFormFieldOption · object[]

The selectable options, for choice fields (select, radio, checkbox).

importContract
BookingFormFieldImportContract · object

How to express an answer for this field in an import payload, and how to find it again on booking reads.

Example: