Skip to main content
GET
List available fields

Authorizations

Authorization
string
header
required

Bearer authentication using your BookingShake API key. Retrieve your API key from Settings > Integrations in your BookingShake dashboard.

Response

List of fields retrieved successfully

value
string

Unique field identifier

Example:

"Abc123XyZ789"

type
string

Field type (e.g., text, number, date, select)

Example:

"text"

collection
enum<string>

Indicates where the field should be used: 'clients' (contact.custom_fields), 'accounts' (company.custom_fields), or 'reservations' (booking.custom_fields)

Available options:
clients,
accounts,
reservations
Example:

"clients"

code
string

Field code/identifier. For custom fields, follows the format 'custom_XXXXXXXXXXX'

Example:

"custom_a1b2c3d4e5"

label
string

Field display label (translated based on venue's default language)

Example:

"Event Type"

isRequiredInBO
boolean

Whether the field is required in the back office

Example:

false

isCustom
boolean

Indicates if this is a custom field (true) or a default system field (false)

Example:

false

data
object[]

Additional data for select-type fields (list of available options)

Example: