Bookafy API Documentation

This is the complete API documentation for connecting to the Bookafy API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Bookafy: Schedule appointments, manage customers, and coordinate staff availability. Keep reading to get started.

Quickstart

Before you run your first Bookafy request, you need three things:

A MindCloud account — sign in or create an account at MindCloud.
A MindCloud API Key — create one in API Keys. Keep it on your server.
At least one Bookafy connection — create or choose one in Connections. Note its connectionId.

Every Bookafy action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/bookafy/latest/actions/{actionSlug}

You need a MindCloud API Key and a Bookafy connection. Then call an action such as Get Customer:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/bookafy/latest/actions/get-customer" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Bookafy account that should run the action. MindCloud stores and refreshes the Bookafy credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Connect your Bookafy API key

Use a Bookafy account with API access. Bookafy says the full API list is available after signing in at https://app.bookafy.com/apidoc.

Sign in to Bookafy
Sign in with the Bookafy account that owns the scheduling data you want MindCloud to access.
Login
Open the Bookafy API documentation
Open the in-app API documentation page to confirm your account has API access and to review the available /api/v2 endpoints.
API Documentation
Copy the API key for your account
Copy the Bookafy API key used for /api/v2 requests and paste it into the MindCloud connection as the API Key value.

Bookafy actions

All 13 published actions for this Bookafy version. Each page documents the endpoint, arguments, and response controls.

More Productivity apps on the Universal API, behind the same REST shape. Or browse all apps.

Quickstart

Authentication

Connect your Bookafy API key

Bookafy actions

Related apps