Getting started with bookafy api | bookafy

Getting started with the Bookafy API

Put your data to work so you can accomplish tasks quicker

API v2: Our current, actively maintained API. The Bookafy API v2 is REST-based and has predictable resource-oriented URLs. It uses JSON for request and response bodies and standard HTTP methods, authentication, and response codes.

Embed API: Our simpler, easy-to-use API that lets you add a Bookafy landing or booking page to your website. 

Webhook API: Our friendly, lightweight API that lets you automatically receive Bookafy data with webhook subscriptions anytime invitees schedule, cancel, or reschedule a meeting.Build integrated apps for your team or customers

Authenticating requests

The Bookafy API v2 uses personal access tokens and OAuth 2.0 to authenticate requests. Choose either depending on who’s using the application you’re integrating with Bookafy.

  • If you’re integrating an internal application that only your team will use, authenticate with personal access tokens.

  • If you’re integrating a public application that many Bookafy users will use, authenticate with OAuth.

To see specific examples of when you might choose either authentication method, see when to choose between personal access tokens and OAuth 2.0.

Review your API and webhook permissions

Access to the Bookafy API is determined by your subscription and user role in Bookafy , while access to webhooks is reserved for members on paid premium subscriptions and above. If your user role is not sufficient, some HTTP methods, including those that access organization-wide Bookafy data, may not be available to you or others because of insufficient user privileges.