Module "API (Interface)"

Book appointments directly from your own application.

With the REST API, your website, your customer portal, your app or your CRM system queries available appointments and creates bookings. Your customers stay in their familiar environment and do not have to open the appointment scheduler themselves.

Your benefits at a glance

Your design, your process: The booking flow looks exactly the way you want it to.
Everything in one place: Appointments arrive in the appointment scheduler immediately, including the usual notification emails.
Quickly implemented: Six calls in JSON format cover the complete booking process.
Securely connected: Authentication is done with a token that you generate yourself and can renew at any time.

Application examples

Your own booking flow

The appointment booking blends seamlessly into the design of your website.

Mobile app

Your customers book appointments directly in your own app.

CRM and practice software

Appointments are created from the application you work with every day.

Shop and customer portal

The appointment is assigned directly during the order process or in the members area.

AI phone assistant

A voice assistant takes calls, names available appointments and books them during the conversation via the API.

How a booking works

1. Calendar

Your application queries the available appointment calendars and selects the right one.

2. Appointment reason

For every calendar the API returns the services with description and duration.

3. Day

Only those days are returned on which an appointment is actually available.

4. Time

For the selected day you receive all available appointment times.

5. Form fields

You define in the appointment scheduler which details you ask your customers for. The API returns the matching fields.

6. Booking

The appointment is booked, and the customer record and the appointment are created in the process.

Appointments booked via the API appear in the appointment scheduler immediately and trigger the usual notification emails.

Example: book an appointment

Request

POST /api/bookings
Authorization: Bearer apm_your-token
Content-Type: application/json

{
    "schedule": 1,
    "reason": 1,
    "slot": "2026-05-23 09:00:00",
    "submission": {
        "first_name": "Hans",
        "last_name": "Pitt",
        "email": "hans.pitt@example.com"
    }
}

Response

{
    "booking_id": 142,
    "booking_details_id": "a3f8c2d1e5b6",
    "user_id": 87,
    "slot": "2026-05-23T09:00:00Z"
}

Security and operation

Authentication with a token

You generate the token yourself in the admin area under Configuration → API.
Shown only once

The token is displayed a single time and is stored in the system exclusively as a hash.
Renewable at any time

As soon as you generate a new token, the previous one immediately loses its validity.
300 requests per minute

Plenty of headroom for the ongoing operation of your application.

Ready for more revenue and less effort?

Join Appointmind for growth and success.

View demos View pricing

Show other modules.