Skip to main content
GET
Get Event Detail

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

id
string
required

Query Parameters

timezone
string
required

Response

Successful Response

id
string
required
start
string<date-time>
required
end
string<date-time>
required
type
enum<string>
required
Available options:
APPOINTMENT,
SHIFT,
BLOCK,
GOOGLE_CALENDAR
status
enum<string>
required
Available options:
PENDING,
RESERVED,
CONFIRMED,
CANCELLED,
COMPLETED,
OVERRIDABLE,
NO_SHOW
organizer
UserTiny · object
required
title
string | null
isAllDay
boolean
default:false
location
LocationSummary · object | null
roomId
string | null
attendees
AttendeeDetail · object[]
recurringEventId
string | null
recurringEvent
RecurringEventDetail · object | null
segments
(EventServiceDetail · object | EventBookableSegmentTiny · object | EventPrepSegmentTiny · object | EventCleanupSegmentTiny · object)[]

Service segment response with full service details.

icons
enum<string>[]
Available options:
BOOKING_FEE_PAID,
NEW_PATIENT,
SCHEDULED_BY_AI,
FORM_COMPLETED,
FORM_NOT_COMPLETED,
CHECKED_IN,
ONLINE_BOOKING,
NOTE_LINKED,
PROVIDER_REQUESTED
capacity
integer | null
quickNotes
QuickNoteSummary · object[] | null
carePlan
CarePlanStepTiny · object | null

Minimal care-plan step reference for task/event display.

createdDate
string<date-time> | null
updatedDate
string<date-time> | null
description
string | null
gcalBusy
boolean | null
patientRequestedProvider
boolean
default:false
isBusinessBlock
boolean
default:false
locationId
string | null
formCompleted
boolean | null
reminders
string<date-time>[]
recurrenceModificationMode
enum<string> | null

Enum representing the different modes for handling recurring event modifications Used when modifying recurring events to specify which occurrences should be affected

Available options:
this,
future,
all
attribution
EventAttributionSummary · object | null

Last-touch outbound attribution summary for an appointment.