An API (Application Programming Interface) allows two technologies to talk to one another.
Different types of HTTP methods tell the API what you want to do with the data
For example, you can either:
GET: getting information that already exists
POST: creating something new
PATCH: modifying information that already exists
DELETE: removing information that already exists
In January 2020, we launched our v2 API. The documentation is available here.
Currently, the API includes calls for event information only. However, we plan on making booking data available in the future too.
You can create an API access token here on any Bookwhen account.
Restrictions within the API
Our current API only allows you to GET certain types of information that the booker can plug into their website.
We only allow the following:
List all or singular; events, locations; attachments; tickets, and class passes.
This means that those using the API can show the above (public information on your scheduling page) on your site. (Please note that this is view only).
The API does not allow for bookings to be made, and you would need to create a button that, when selected, the booker gets directed to your Bookwhen site.
Additionally, the API cannot pull the above information into your own CRM of choice as it currently does not allow for reporting metrics.
How often does the API pull data from Bookwhen?
You decide how often the data is pulled. You or your development team can add additional code when using the API to specify how often the information gets pulled and/or refreshed.
Version 1.0.0 (deprecated)
Our v1 API is now deprecated. The documentation is available here. If you require a v1 API access key for your account, please email firstname.lastname@example.org with your account link.