The Booked API provides programmatic access to nearly all data and actions available through the Booked user interface.
Getting Started with the API #
The Booked API comes bundled with the Booked web application, though it is disabled by default.
To enable the API, open Application Configuration and set api.enabled to true. Once the API is enabled it is available at https://your-booked-url/Web/Services
Latest Documentation #
The complete, most up to date documentation on the API can be found on your local instance by simply opening https://your-booked-url/Web/Services in your browser.
API Basics #
The Booked API is “REST-like”. All API methods are resource based and are accessible using plain HTTP requests sending and receiving JSON data.
When browsing the Booked live API documentation, each service description contains some important information.
Method Type – GET, POST, or DELETE
Name – This is the name of the service endpoint and the URL segment to use.
Description – A brief description of what the service does and any optional parameters.
Route – The full route and variables needed to invoke this endpoint. Any portion that begins with a : denotes a variable that must be provided. Pay attention to any trailing slashes – those are required when specified.
Response – An example JSON response (if applicable).
Request – An example JSON request (if applicable).
