v1.2.0 • Latest Stable

API Documentation

Integrate BookEase into your applications. Manage bookings, services, and users programmatically with our RESTful API.

Introduction

The BookEase API is designed to be simple, predictable, and RESTful. All requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Base URL

https://api.bookease.com/v1

Authentication

BookEase uses API keys and Bearer tokens to authenticate requests. You can manage your keys in the developer dashboard.

Bearer Token Example

Authorization: Bearer sk_live_abc123xyz789...

Include the token in the `Authorization` header of every request. Tokens expire after 24 hours. Use refresh tokens to obtain new access tokens securely.

Bookings

POST /bookings Create a new booking

Parameter	Type	Required	Description
`service_id`	string	Required	ID of the service to book
`datetime`	ISO 8601	Required	Requested booking time
`customer_name`	string	Required	Full name of the customer
`notes`	string	Optional	Additional instructions

{
  "service_id": "svc_928374",
  "datetime": "2025-08-15T14:00:00Z",
  "customer_name": "Alex Johnson",
  "notes": "First-time visit, prefers evening slot"
}

{
  "id": "bk_738291",
  "status": "confirmed",
  "service_id": "svc_928374",
  "datetime": "2025-08-15T14:00:00Z",
  "customer_name": "Alex Johnson",
  "created_at": "2025-01-20T10:23:15Z"
}

GET /bookings/:id Retrieve booking details

Returns a single booking object by its ID. Returns `404` if not found.

GET /v1/bookings/bk_738291
Headers: Authorization: Bearer <token>

Services

GET /services List all available services

Supports pagination with `limit` and `offset` query parameters.

GET /v1/services?limit=10&offset=0&category=health
Headers: Authorization: Bearer <token>

Users

GET /users/me Get authenticated user profile

Returns the profile of the user associated with the provided API token.

Status Codes

Code	Meaning	Description
`200`	OK	Request succeeded
`201`	Created	Resource successfully created
`400`	Bad Request	Invalid parameters or malformed JSON
`401`	Unauthorized	Missing or invalid API token
`404`	Not Found	Resource does not exist
`429`	Too Many Requests	Rate limit exceeded
`500`	Server Error	Internal BookEase error

Rate Limits

API access is governed by rate limits to ensure fair usage and system stability. Limits are applied per API key.

Plan	Requests/min	Burst Limit
Free	100	20
Pro	1,000	100
Business	10,000	500

When you exceed your limit, the API returns a `429 Too Many Requests` status code. The `Retry-After` header indicates how many seconds to wait before making another request.