Skip to main content

Event

A scheduled event/booking

additional_infostringnullable

Additional event information

attendeesobject[]required

All event attendees

buffer_afterintegerrequired

Buffer time after event in minutes

buffer_beforeintegerrequired

Buffer time before event in minutes

cancel_reasonstringnullable

Reason for cancellation

canceled_atdate-timenullable

When the event was canceled

conferencing objectrequired

Video conferencing details

instructionsstringnullable

Join instructions

join_urlstringnullable

Join URL

meeting_idstringnullable

Meeting ID

typestringrequired

Conferencing type

created_atdate-timerequired

When the event was created

descriptionstringnullable

Event description

description_settings objectrequired

Settings for description generation

include_attendeesbooleanrequired
include_fieldsbooleanrequired
include_link_namebooleanrequired
durationintegerrequired

Event duration in minutes

end_atdate-timerequired

Event end time

idstringrequired

Unique event identifier (opaque ID)

is_group_sessionbooleanrequired

Whether this is a group session

link objectnullable

Associated scheduling link (preview)

idstringrequired

Link ID

namestringrequired

Link name

slugstringrequired

Link slug

locationstringnullable

Event location description

location_settingsobject[]nullable

Location settings

maximum_group_sizeintegerrequired

Maximum number of attendees for group session

metadataobjectrequired

Additional event metadata

organizer objectnullable

The organizer of the event

display_namestringrequired

Attendee display name

Example: John Daker
emailstringrequired

Attendee email address

Example: jdaker@example.com
fieldsobject[]required

Attendee custom fields

first_namestringrequired

Attendee first name

Example: John
idstringrequired

Unique attendee identifier (opaque ID)

Example: attendee_7RDQF0G5VT8PAV4ERN90B5Q27Y
is_organizerbooleanrequired

Is attendee organizer?

Example: false
last_namestringrequired

Attendee last name

Example: Daker
marketing_opt_inbooleanrequired

Has attendee opted in to marketing?

Example: false
phone_numberstringnullable

Attendee phone number

Example: +15555555555
response_statusstringrequired

Attendee response status

Example: accepted
time_zonestringrequired

Attendee time zone

Example: America/New_York
original_end_atdate-timenullable

Original end time (if rescheduled)

original_start_atdate-timenullable

Original start time (if rescheduled)

payment objectnullable

Payment information (if applicable)

amount_discountintegerrequired

Total amount of discounts (in cents)

amount_shippingintegerrequired

Total amount of shipping (in cents)

amount_taxintegerrequired

Total amount of tax (in cents)

amount_totalintegerrequired

Total amount charged (in cents)

statestringrequired

Payment state

Possible values: [awaiting_checkout, paid]

urlurinullablerequired

URL to complete payment

pollobjectnullable

Associated poll (if any)

reschedule_reasonstringnullable

Reason for rescheduling

rescheduled_atdate-timenullable

When the event was rescheduled

scheduler objectnullable

The scheduler of the event

display_namestringrequired

Attendee display name

Example: John Daker
emailstringrequired

Attendee email address

Example: jdaker@example.com
fieldsobject[]required

Attendee custom fields

first_namestringrequired

Attendee first name

Example: John
idstringrequired

Unique attendee identifier (opaque ID)

Example: attendee_7RDQF0G5VT8PAV4ERN90B5Q27Y
is_organizerbooleanrequired

Is attendee organizer?

Example: false
last_namestringrequired

Attendee last name

Example: Daker
marketing_opt_inbooleanrequired

Has attendee opted in to marketing?

Example: false
phone_numberstringnullable

Attendee phone number

Example: +15555555555
response_statusstringrequired

Attendee response status

Example: accepted
time_zonestringrequired

Attendee time zone

Example: America/New_York
scope objectnullable

Associated scope/team

idstringrequired

Scope ID

namestringrequired

Scope name

slugstringrequired

Scope slug

start_atdate-timerequired

Event start time

statestringrequired

Event state

Possible values: [confirmed, canceled, awaiting_reschedule, awaiting_checkout, checkout_expired, awaiting_approval, declined, tentative]

summarystringrequired

Event title/summary

urlurirequired

Public URL for the event

Event
{
"additional_info": "Please prepare project overview",
"attendees": [
{
"display_name": "John Doe",
"email": "john@example.com",
"fields": [],
"first_name": "John",
"id": "attendee_123",
"is_organizer": true,
"last_name": "Doe",
"marketing_opt_in": false,
"phone_number": null,
"response_status": "accepted",
"time_zone": "America/New_York"
},
{
"display_name": "Jane Smith",
"email": "jane@example.com",
"fields": [],
"first_name": "Jane",
"id": "attendee_456",
"is_organizer": false,
"last_name": "Smith",
"marketing_opt_in": true,
"phone_number": "+1234567890",
"response_status": "accepted",
"time_zone": "America/New_York"
}
],
"buffer_after": 0,
"buffer_before": 15,
"cancel_reason": null,
"canceled_at": null,
"conferencing": {
"instructions": "Click the link to join",
"join_url": "https://zoom.us/j/123456789",
"meeting_id": "123456789",
"type": "zoom"
},
"created_at": "2024-01-15T10:30:00Z",
"description": "Discussing project requirements",
"description_settings": {
"include_attendees": true,
"include_fields": false,
"include_link_name": true
},
"duration": 30,
"end_at": "2024-01-20T14:30:00Z",
"id": "event_abc123",
"is_group_session": false,
"link": {
"id": "link_abc123",
"name": "30 Minute Meeting",
"slug": "30min"
},
"location": "Zoom meeting",
"location_settings": [
{
"integration_id": "zoom_123",
"type": "zoom"
}
],
"maximum_group_size": 1,
"metadata": {},
"organizer": {
"display_name": "John Doe",
"email": "john@example.com",
"fields": [],
"first_name": "John",
"id": "attendee_123",
"is_organizer": true,
"last_name": "Doe",
"marketing_opt_in": false,
"phone_number": null,
"response_status": "accepted",
"time_zone": "America/New_York"
},
"original_end_at": null,
"original_start_at": null,
"payment": {
"amount_discount": 0,
"amount_shipping": 0,
"amount_tax": 100,
"amount_total": 1000,
"state": "awaiting_checkout",
"url": "https://checkout.stripe.com/xxxxxxxxx"
},
"poll": null,
"reschedule_reason": null,
"rescheduled_at": null,
"scheduler": {
"display_name": "Jane Smith",
"email": "jane@example.com",
"fields": [],
"first_name": "Jane",
"id": "attendee_456",
"is_organizer": false,
"last_name": "Smith",
"marketing_opt_in": true,
"phone_number": "+1234567890",
"response_status": "accepted",
"time_zone": "America/New_York"
},
"scope": {
"id": "scope_xyz789",
"name": "Sales Team",
"slug": "sales"
},
"start_at": "2024-01-20T14:00:00Z",
"state": "confirmed",
"summary": "30 Minute Meeting with John Doe",
"url": "https://savvycal.com/events/event_abc123"
}