Entwickler

API-Referenz

Basis-URL https://bookbaseapi.com/api/v1. Authentifizierung per Authorization: Bearer bb_live_…. Die vollständige Spezifikation gibt es als OpenAPI 3.1.

Workspace

get/workspace

Get the workspace of the API key

Antworten

200 Workspace
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

Services

get/servicesservices:read

List services

Parameter

active

query

boolean

Only return services that are bookable online

Antworten

200 Services
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

post/servicesservices:write

Create a service

Request-Body

name*	string
description	string \| null
durationMinutes*	integer
price	object \| null
location	object
color	string
bufferBeforeMinutes	integer
bufferAfterMinutes	integer
minimumNoticeMinutes	integer
maximumAdvanceDays	integer
slotIntervalMinutes	integer \| null
capacity	integer
requiresConfirmation	boolean
isActive	boolean
questions	object[]

Antworten

201 Created service
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

get/services/{id}services:read

Get a service

Parameter

id*

path

string (uuid)

Antworten

200 Service
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

patch/services/{id}services:write

Update a service

Parameter

id*

path

string (uuid)

Request-Body

name*	string
description	string \| null
durationMinutes*	integer
price	object \| null
location	object
color	string
bufferBeforeMinutes	integer
bufferAfterMinutes	integer
minimumNoticeMinutes	integer
maximumAdvanceDays	integer
slotIntervalMinutes	integer \| null
capacity	integer
requiresConfirmation	boolean
isActive	boolean
questions	object[]

Antworten

200 Updated service
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

delete/services/{id}services:write

Delete a service

Services with existing bookings are archived instead of being removed.

Parameter

id*

path

string (uuid)

Antworten

200 Deleted
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

Availability

get/availabilityavailability:read

Get weekly hours and upcoming date overrides

Antworten

200 Availability
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

put/availabilityavailability:write

Replace the weekly hours

Request-Body

timeZone*	string
weeklyRules*	WeeklyRule[]

Antworten

200 Saved
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

get/slotsavailability:read

List bookable slots

Returns free slots grouped by date in the requested time zone. The range may span up to 62 days.

Parameter

serviceId*	query	string (uuid)
from*	query	string (date)	Beispiel: 2026-10-05
to*	query	string (date)	Beispiel: 2026-10-11
timeZone	query	string	Beispiel: Europe/Berlin

Antworten

200 Slots
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

Bookings

get/bookingsbookings:read

List bookings

Parameter

view	query	"upcoming" \| "past" \| "pending" \| "cancelled" \| "all"
from	query	string (date-time)
to	query	string (date-time)
serviceId	query	string (uuid)
search	query	string
page	query	integer
limit	query	integer

Antworten

200 Bookings
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

post/bookingsbookings:write

Create a booking

The slot must be free according to availability, buffers and existing bookings. Returns 409 if it is taken.

Request-Body

serviceId*	string (uuid)
startAt*	string (date-time)	Beispiel: "2026-10-05T07:00:00.000Z"
timeZone*	string	Beispiel: "Europe/Berlin"
name*	string
email*	string (email)
phone	string \| null
message	string \| null
answers	object
locale	"de" \| "en"	Standard: "de"
status	"pending" \| "confirmed"	Standard: "confirmed"
sendNotifications	boolean	Standard: true

Antworten

201 Created booking
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
409 The slot is no longer available
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

get/bookings/{id}bookings:read

Get a booking

Parameter

id*

path

string (uuid)

Antworten

200 Booking
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

post/bookings/{id}/cancelbookings:write

Cancel a booking

Parameter

id*

path

string (uuid)

Request-Body

reason	string
notifyCustomer	boolean	Standard: true

Antworten

200 Cancelled booking
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

post/bookings/{id}/reschedulebookings:write

Move a booking to a new start time

Parameter

id*

path

string (uuid)

Request-Body

startAt*	string (date-time)
notifyCustomer	boolean	Standard: true

Antworten

200 Rescheduled booking
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

post/bookings/{id}/confirmbookings:write

Confirm a pending booking request

Parameter

id*

path

string (uuid)

Antworten

200 Confirmed booking
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

Customers

get/customerscustomers:read

List customers

Parameter

search	query	string
page	query	integer
limit	query	integer

Antworten

200 Customers
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

Webhooks

get/webhookswebhooks:write

List webhook endpoints

Antworten

200 Endpoints
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

post/webhookswebhooks:write

Create a webhook endpoint

The response contains the signing secret once. Store it securely.

Request-Body

url*	string (uri)	Beispiel: "https://example.com/hooks/bookbase"
description	string \| null
events*	"booking.created" \| "booking.confirmed" \| "booking.cancelled" \| "booking.rescheduled" \| "booking.completed" \| "booking.no_show"[]

Antworten

201 Created endpoint
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

delete/webhooks/{id}webhooks:write

Delete a webhook endpoint

Parameter

id*

path

string (uuid)

Antworten

200 Deleted
401 Missing or invalid API key
402 Plan does not include this feature or a limit is reached
403 The API key lacks the required scope
422 Validation failed
429 Rate limit exceeded (600 requests per minute per key)

Objekte

Booking

id	string (uuid)
reference	string	Beispiel: "BB-7K3D9Q"
status	"pending" \| "confirmed" \| "cancelled" \| "completed" \| "no_show"
service	object
startAt	string (date-time)
endAt	string (date-time)
durationMinutes	integer
timeZone	string	Beispiel: "Europe/Berlin"
locale	"de" \| "en"
customer	object
message	string \| null
answers	object
price	object \| null
location	object
source	"page" \| "widget" \| "api" \| "dashboard"
cancellation	object \| null
createdAt	string (date-time)
updatedAt	string (date-time)

Service

id	string (uuid)
name	string	Beispiel: "Erstberatung"
description	string \| null
durationMinutes	integer	Beispiel: 30
price	object \| null
location	object
color	string	Beispiel: "#476e66"
bufferBeforeMinutes	integer
bufferAfterMinutes	integer
minimumNoticeMinutes	integer
maximumAdvanceDays	integer
slotIntervalMinutes	integer \| null
capacity	integer
requiresConfirmation	boolean
isActive	boolean
position	integer
questions	object[]
createdAt	string (date-time)
updatedAt	string (date-time)

Slot

startAt	string (date-time)
endAt	string (date-time)
remainingCapacity	integer

Availability

timeZone	string
weeklyRules	WeeklyRule[]
overrides	object[]

Customer

id	string (uuid)
name	string
email	string (email)
phone	string \| null
bookingsCount	integer
lastBookingAt	string \| null (date-time)
createdAt	string (date-time)

WebhookEndpoint

id	string (uuid)
url	string
description	string \| null
events	"booking.created" \| "booking.confirmed" \| "booking.cancelled" \| "booking.rescheduled" \| "booking.completed" \| "booking.no_show"[]
isActive	boolean
disabledAt	string \| null (date-time)
createdAt	string (date-time)

Error

error*

object