Get an event type

Headers

cal-api-version

string

default:2024-06-14

required

Must be set to 2024-06-14

Authorization

string

required

value must be Bearer <token> where <token> is api key prefixed with cal_ or managed user access token

Path Parameters

eventTypeId

string

required

Response

200 - application/json

status

enum<string>

required

Available options:

success,

error

Example:

"success"

data

object

required

Show child attributes

data.id

number

required

Example:

1

data.lengthInMinutes

number

required

Example:

60

data.title

string

required

Example:

"Learn the secrets of masterchief!"

data.slug

string

required

Example:

"learn-the-secrets-of-masterchief"

data.description

string

required

Example:

"Discover the culinary wonders of Argentina by making the best flan ever!"

data.locations

object[]

required

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5
• Option 6

Show child attributes

data.locations.type

enum<string>

required

only allowed value for type is address

Available options:

address,

link,

integration,

phone,

attendeeAddress,

attendeePhone,

attendeeDefined,

organizersDefaultApp

Example:

"address"

data.locations.address

string

required

Example:

"123 Example St, City, Country"

data.locations.public

boolean

required

data.bookingFields

object[]

required

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5
• Option 6
• Option 7
• Option 8
• Option 9
• Option 10
• Option 11
• Option 12
• Option 13
• Option 14
• Option 15
• Option 16
• Option 17
• Option 18
• Option 19

Show child attributes

data.bookingFields.type

enum<string>

default:name

required

only allowed value for type is name. Used for having 1 booking field for both first name and last name.

Available options:

name,

email,

phone,

address,

text,

number,

textarea,

select,

multiselect,

multiemail,

checkbox,

radio,

boolean,

url

Example:

"name"

data.bookingFields.isDefault

object

required

This property is always true because it's a default field

Example:

true

data.bookingFields.slug

string

default:name

required

data.bookingFields.required

boolean

required

data.bookingFields.label

string

data.bookingFields.placeholder

string

data.bookingFields.disableOnPrefill

boolean

Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if URL contains query parameter &name=bob, the name field will be prefilled with this value and disabled.

data.disableGuests

boolean

required

data.recurrence

object

required

Show child attributes

data.recurrence.interval

number

required

Repeats every {count} week | month | year

Example:

10

data.recurrence.occurrences

number

required

Repeats for a maximum of {count} events

Example:

10

data.recurrence.frequency

enum<string>

required

Available options:

yearly,

monthly,

weekly

data.metadata

object

required

data.price

number

required

data.currency

string

required

data.lockTimeZoneToggleOnBookingPage

boolean

required

data.forwardParamsSuccessRedirect

object | null

required

data.successRedirectUrl

object | null

required

data.isInstantEvent

boolean

required

data.scheduleId

number | null

required

data.ownerId

number

required

Example:

10

data.users

string[]

required

data.lengthInMinutesOptions

number[]

If you want that user can choose between different lengths of the event you can specify them here. Must include the provided lengthInMinutes.

Example:

[15, 30, 60]

data.slotInterval

object | null

Example:

60

data.minimumBookingNotice

number

Example:

0

data.beforeEventBuffer

number

Example:

0

data.afterEventBuffer

number

Example:

0

data.seatsPerTimeSlot

object | null

data.seatsShowAvailabilityCount

boolean | null

data.bookingLimitsCount

object

data.onlyShowFirstAvailableSlot

boolean

data.bookingLimitsDuration

object

data.bookingWindow

object[]

Limit how far in the future this event can be booked

• Option 1
• Option 2
• Option 3

Show child attributes

data.bookingWindow.type

enum<string>

required

Whether the window should be business days, calendar days or a range of dates

Available options:

businessDays,

calendarDays,

range

data.bookingWindow.value

number

required

How many business day into the future can this event be booked

Example:

5

data.bookingWindow.rolling

boolean

  Determines the behavior of the booking window:
  - If **true**, the window is rolling. This means the number of available days will always be equal the specified 'value' 
    and adjust dynamically as bookings are made. For example, if 'value' is 3 and availability is only on Mondays, 
    a booker attempting to schedule on November 10 will see slots on November 11, 18, and 25. As one of these days 
    becomes fully booked, a new day (e.g., December 2) will open up to ensure 3 available days are always visible.
  - If **false**, the window is fixed. This means the booking window only considers the next 'value' days from the
    moment someone is trying to book. For example, if 'value' is 3, availability is only on Mondays, and the current 
    date is November 10, the booker will only see slots on November 11 because the window is restricted to the next 
    3 calendar days (November 10–12).

Example:

true

data.bookerLayouts

object

Show child attributes

data.bookerLayouts.defaultLayout

enum<string>

required

Available options:

month,

week,

column

data.bookerLayouts.enabledLayouts

enum<string>[]

required

Array of valid layouts - month, week or column

Available options:

month,

week,

column

data.confirmationPolicy

object

data.requiresBookerEmailVerification

boolean

data.hideCalendarNotes

boolean

data.color

object

Show child attributes

data.color.lightThemeHex

string

required

Color used for event types in light theme

Example:

"#292929"

data.color.darkThemeHex

string

required

Color used for event types in dark theme

Example:

"#fafafa"

data.seats

object

Show child attributes

data.seats.seatsPerTimeSlot

number

required

Number of seats available per time slot

Example:

4

data.seats.showAttendeeInfo

boolean

required

Show attendee information to other guests

Example:

true

data.seats.showAvailabilityCount

boolean

required

Display the count of available seats

Example:

true

data.offsetStart

number

data.customName

string

data.destinationCalendar

object

Show child attributes

data.destinationCalendar.integration

string

required

The integration type of the destination calendar. Refer to the /api/v2/calendars endpoint to retrieve the integration type of your connected calendars.

data.destinationCalendar.externalId

string

required

The external ID of the destination calendar. Refer to the /api/v2/calendars endpoint to retrieve the external IDs of your connected calendars.

data.useDestinationCalendarEmail

boolean

data.hideCalendarEventDetails

boolean