Skip to content

EventTypes Object ​



id
string
REQUIRED · 

Unique identifier of the Event Type

name
string

Slug or unique readable name of the Event Type

label
string

Human readable name of the Event Type

status
string

Status of the Event Type

All possible enum values:
  • active
  • archived
urls
object[]

URLs associated with the Event Type

url
string
type
string

The type of the URL

All possible enum values:
  • scheduling
color
string

The color associated with this Event Type

duration
number

The length of the Event scheduled using this Event Type in minutes

description
string

The description of the Event Type

allow_scheduling
boolean

Whether scheduling an Event is allowed using this Event Type

position
number

The position of the Event Type on a listing page

form_fields
object[]

Form fields associated with the Event Type

label
string

Label used for the field

type
string

The type of the form field

All possible enum values:
  • string
  • text
  • rich_text
  • number
  • boolean
  • date
  • datetime
  • time
  • enum
  • array
  • file
is_enabled
boolean

Is the form field enabled?

is_required
boolean

Is the form field required to be answered?

position
number

Order of the field in the form

options
object[]

The choices to be selected in case of multi-choice fields

label
string

Human readable name for the choice

value
string

The value for the choice

locations
object[]

The location choices associated with the Event Type

id
string

The unique identifier of the location.

name
string

The name of the location.

address
object
street_1
string

The first line of the street address.

street_2
string

The second line of the street address.

city
string

The city of the address.

state
string

The state of the address.

country
string

The country of the address.

postal_code
string

The postal code of the address.

url
string

The URL of the location.

coordinates
object
latitude
number

The latitude of the location.

longitude
number

The longitude of the location.

created_at
string · date-time

The date and time at which this Event Type was created

updated_at
string · date-time

The date and time at which this Event Type was last modified

remote_data
object

Raw data returned from the remote API call.