---
openapi: 3.0.1
info:
  title: API Documentation
  description: |
    **Welcome to the Appointments Booking API!**

    Our software facilitates the booking of appointments and group events with customers, providing options for various services and efficient organization of appointments for your staff, all in one centralized platform.
    The API enables you to perform fundamental tasks, such as adding new customer information or scheduling appointments. It serves as a tool to integrate appointment booking functionality into other software.

    To effectively utilize this API, we recommend having development skills or engaging a developer. For any developer-related inquiries about the API, please send an email to **api@bookafy.com**.

    **Base Endpoint URL:**

    This is the base endpoint for all API services: **https://app.[domain_name].com**
  version: 3.0.0
paths:
  "/api/v3/api_subscriptions":
    "$ref": "./webhook_part1.yaml"
  "/api/v3/api_subscriptions/{id}":
    "$ref": "./webhook_part2.yaml"
  "/api/v3/appointments":
    "$ref": "./appointments_part1.yaml"
  "/api/v3/appointments/{appointment_id}":
    "$ref": "./appointments_part2.yaml"
  "/api/v3/appointment_types":
    "$ref": "./appointment_types.yaml"
  "/api/v3/classes":
    "$ref": "./classes.yaml"
  "/api/v3/sessions":
    "$ref": "./session_attendee.yaml"
  "/api/v3/classes/{id}":
    "$ref": "./class_session_details.yaml"
  "/api/v3/customers":
    "$ref": "./customers_part1.yaml"
  "/api/v3/customers/{customer_id}":
    "$ref": "./customers_part2.yaml"
  "/api/v3/customers/{customer_id}?soft_delete={soft_delete}":
    "$ref": "./customers_part3.yaml"
  "/api/v3/customers/{customer_id}?soft_delete=true":
    "$ref": "./customers_part4.yaml"
  "/api/v3/services":
    "$ref": "./appointment_types_services.yaml"
  "/api/v3/staff_members":
    "$ref": "./staff_members_part1.yaml"
  "/customers/available_time":
    "$ref": "./staff_members_part2.yaml"
  "/api/v3/me":
    "$ref": "./users.yaml"
  "/api/v3/authenticate":
    "$ref": "./oauth.yaml"
security:
- ApiKeyAuth: []
tags:
- name: Webhooks
- name: Appointments
- name: Customers
- name: Appointment Types/Services
- name: Classes/Sessions
- name: Staff Members
- name: Users
- name: OAuth
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api-key