Skip to main content
GET
Get public appointment details

Path Parameters

appointmentId
string
required

The unique identifier of the appointment

Query Parameters

secret
string

Optional secret key for accessing appointment details

Response

200 - application/json

Public appointment details retrieved successfully

id
string
required

Appointment unique identifier

meetingInfo
object
required

Meeting information including title, duration, and other details

online
boolean
required

Whether the appointment is conducted online

start
string
required

Appointment start time (ISO string)

end
string
required

Appointment end time (ISO string)

isCancelled
boolean
required

Whether the appointment has been cancelled

channel
enum<string>
required

Meeting channel type (e.g., video conference platform)

Available options:
local,
local-attendee,
google,
zoom,
phone,
phone-incoming,
whatsapp,
connect,
webex,
skypeForConsumer,
skypeForBusiness,
teamsForBusiness,
teamsForBusiness2,
teamsForExchange,
teams2ForExchange,
custom,
resource,
whereby,
kmeet,
zava,
jitsi,
nextcloudTalk,
openTalk
hosts
object
required

List of appointment hosts with basic information

company
object
required

Public company information

disableActionButtons
boolean
required

Whether action buttons (reschedule, cancel) are disabled for this appointment

language
string
required

Attendee's resolved language for this booking

showConfetti
boolean
required

Whether to show confetti animation on the confirmation page

enableWithdrawalButton
boolean
required

Whether to show the withdrawal button ("Widerrufsbutton") on the confirmation page. Off by default; required from 19 June 2026 (§ 356a BGB) for B2C distance contracts with a right of withdrawal.

createdAt
string
required

When the appointment was booked (contract conclusion). The 14-day statutory withdrawal window runs from this timestamp.

meetingTypeId
string

Meeting type ID associated with this appointment

location
string

Physical location address

cancellationPolicy
object

Cancellation policy for this appointment

reschedulingPolicy
object

Rescheduling policy for this appointment

Meeting link - only provided with proper authentication

ics
string

ICS calendar file content - only provided with proper authentication

customCss
string

Custom CSS styling for the appointment page

queueId
string

Queue ID - required for rescheduling on round robin meetings

recurringSeriesId
string

Recurring series ID if this appointment is part of a recurring series

occurrenceNumber
number

1-based index of this appointment within the recurring series

recurringSeries
object

Recurring series information if this appointment is part of a recurring series

isBundleBooking
boolean

Whether this appointment was booked as part of a bundle

bundleId
string

Bundle ID if this is a bundle booking

bundleItems
object[]

Bundle items if this is a bundle booking