Module

Booking

Booking ist eine Calendly-artige Funktion: Mitarbeitende oder Teams legen buchbare Services mit Verfügbarkeitsregeln an; externe Personen buchen über einen Public-Slug, ohne Codemeta-Account.

Resources

Resource	Pfad	Permission-Präfix
Termin-Links	`/api/v1/booking_links`	`booking_link`
Services	`/api/v1/booking_services`	`booking_service`

Schemas

Service

booking_services4 Permissions

Schema for validating booking service entities

name string erforderlich

Service name

1–200 Zeichen

description string optional

Optional service description

max 2000 Zeichennullable

systemKey string optional

Marker for auto-provisioned, internal-only system services (e.g. "project_meeting"). Used to look up / lazily create a tenant-wide shared service. Null for normal user-created services.

max 64 Zeichennullable

durationMinutes integer erforderlich

Appointment duration in minutes

Werte

1530456090120

bufferBeforeMinutes integer optional

Buffer time before the appointment in minutes

0 – 480Default: 0

bufferAfterMinutes integer optional

Buffer time after the appointment in minutes

0 – 480Default: 0

price integer optional

Price in cents

≥ 0nullable

currency string optional

Currency code (ISO 4217)

max 3 ZeichenDefault: "EUR"

priceDisplayMode string optional

How the price is displayed to the customer

Werte

showhideon_request

Default: "show"

location object optional

Where the appointment takes place

nullable

type string erforderlich

Location type

Werte

on_siteremotephonecustom

value string optional

Location value (address, URL, phone number, etc.)

max 500 Zeichennullable

assignedUserIds uuid[] erforderlich

User IDs that can be booked for this service

min 1 Items

assignmentMode string erforderlich

How a user is assigned to a booking

Werte

any_availablecustomer_choosessmart_assign

maxConcurrentBookings integer optional

Maximum concurrent bookings per time slot

1 – 10Default: 1

autoConfirm boolean optional

Automatically confirm bookings without manual approval

Default: true

requiresApproval boolean optional

Whether bookings require manual approval

Default: false

isActive boolean optional

Whether the service is active and bookable

Default: true

color string optional

Hex color for calendar display (e.g. #FF5733)

max 7 Zeichennullable

categoryId uuid optional

Category ID for grouping services

nullable

imageFileId uuid optional

File ID for the service image

nullable

onlineMeetingProvider string optional

Online meeting provider for remote appointments

Werte

teamszoomgoogle_meet

nullable

reminderConfig object optional

Reminder configuration

enabled boolean erforderlich

Whether reminders are enabled

emailBefore integer[] optional

Minutes before appointment to send email reminders

Default: []

cancellationPolicy object optional

Cancellation and rescheduling policy

allowCancellation boolean erforderlich

Whether customers can cancel bookings

minHoursBefore integer optional

Minimum hours before appointment to allow cancellation

0 – 720Default: 24

allowReschedule boolean optional

Whether customers can reschedule bookings

Default: true

rescheduleMinHoursBefore integer optional

Minimum hours before appointment to allow rescheduling

0 – 720Default: 24

isGroupBooking boolean optional

Whether this service supports group bookings (multiple participants per slot)

Default: false

maxParticipants integer optional

Maximum participants per slot (only relevant when isGroupBooking=true)

2 – 100nullable

minParticipants integer optional

Minimum participants for the booking to take place

1 – 100nullable

registrationDeadlineHours integer optional

Hours before start after which registration closes

0 – 720nullable

followUpConfig object optional

Follow-up email configuration after appointment

nullable

enabled boolean optional

Default: false

delayHours integer optional

Hours after appointment end to send follow-up

1 – 168Default: 24

includeNps boolean optional

Include NPS rating question in follow-up email

Default: false

customMessage string optional

Custom follow-up message (HTML)

max 2000 Zeichennullable

customFields object[] optional

Custom intake form fields

Default: []

id string erforderlich

Unique field identifier

1–50 Zeichen

type string erforderlich

Field input type

Werte

texttextareadropdowncheckboxnumberemailphone

label object erforderlich

i18n labels (e.g. { de: "Name", en: "Name" })

placeholder object optional

i18n placeholders

nullable

required boolean erforderlich

Whether the field is required

options object[] optional

Dropdown options

nullable

value string optional

label object optional

i18n labels for option

validation object optional

Validation rules

nullable

minLength integer optional

maxLength integer optional

min number optional

max number optional

pattern string optional

Link

booking_links4 Permissions

Schema for validating booking link entities

name string erforderlich

1–200 Zeichen

slug string optional

3–100 ZeichenPatternnullable

serviceId uuid optional

assignedUserIds uuid[] optional

Default: []

technicianMode string optional

all_required = alle Techniker müssen frei sein (1-to-many), any_one = ein verfügbarer reicht (1-of-many)

Werte

all_requiredany_one

Default: "any_one"

assignmentModeOverride string optional

Only relevant when technicianMode=any_one

Werte

any_availablecustomer_choosessmart_assignnull

nullable

durationOverride integer optional

Werte

1530456090120null

nullable

availabilityWindows object[] erforderlich

min 1 Items

mode string optional

recurring = weekday-based, fixed = specific date or date range

Werte

recurringfixed

Default: "recurring"

label string optional

max 100 Zeichennullable

weekdays integer[] optional

ISO weekdays (1=Mo, 7=Su). Required for mode=recurring, empty for mode=fixed.

Default: []

fixedDate date optional

Specific date (YYYY-MM-DD). Required for mode=fixed.

nullable

fixedDateEnd date optional

Optional end date for a date range. Only for mode=fixed.

nullable

startTime string erforderlich

Pattern

endTime string erforderlich

Pattern

validFrom date optional

nullable

validUntil date optional

nullable

schedulingPolicy object optional

minLeadTimeHours integer erforderlich

0 – 720Default: 24

maxLeadTimeDays integer erforderlich

1 – 180Default: 30

slotIntervalMinutes integer erforderlich

Werte

153060

Default: 30

maxBookingsTotal integer optional

≥ 1nullable

maxBookingsPerCustomer integer optional

≥ 1nullable

linkedPartyId string optional

Patternnullable

linkedProjectId string optional

When set, a booking made through this link stamps the created calendar_event with referenceType=PROJECT / referenceId=linkedProjectId so it appears in the project Termine tab.

Patternnullable

eventTitleOverride string optional

Optional title for the created calendar_event (e.g. project context). Falls back to "service.name — customer" when null.

max 200 Zeichennullable

expiresAt datetime optional

nullable

isActive boolean optional

Default: true

customWelcomeMessage string optional

max 2000 Zeichennullable

customConfirmationMessage string optional

max 2000 Zeichennullable

branding object optional

nullable

Public-Buchung

Externe Anwender öffnen einen Buchungs-Link /api/v1/public/book/<slug>, sehen verfügbare Slots und buchen durch:

POST /api/v1/public/book/<slug>/reservations

Die Reservation erscheint im Mandanten als Termin in der Kalender-Sicht. Bei requiresPayment: true schickt der Server eine Stripe-Checkout-Session zurück.

Mehr unter Public Endpoints.

Verwandt

Konventionen
Public Endpoints — Buchungs-Slugs