Skip to content
DEVELOPERS & PARTNERS HUB

Build Powerful Integrations

Official API documentation for integrating online booking, CRM, scheduling, POS, and business management features into your applications

200+
API endpoints
99.98%
Platform uptime
# Get available time slotscurl -X GET "https://api.alteg.io/api/v1/book_times/{company_id}/{staff_id}/{date}" \ -H "Authorization: Bearer {partner_token}" \ -H "Accept: application/vnd.api.v2+json"

Getting Started

The Altegio API allows third-party developers to perform most operations with platform data. When designing methods, we adhered to the REST architecture.

  • All requests are encrypted with TLS 1.2+
  • Rate limit: 200 requests/min or 5 requests/sec per IP
  • Base URL: https://api.alteg.io/api

API Versioning

The API uses URL path versioning. Both V1 and V2 are production-ready. New features may be released in V2 only. V1 endpoints are maintained for backward compatibility.

  • V1 (/v1/...) — Stable, full-featured API
  • V2 (/v2/...) — New endpoints with improved design

Authentication

API requests are authorized per RFC 6749. Two authorization modes:

Partner only (public endpoints):

Authorization: Bearer <partner_token>

Partner + User (business data):

Authorization: Bearer <partner_token>, User <user_token>

Get partner token at Marketplace. Get user token via auth endpoint or app settings.

Date & Time Format

"2026-09-21T23:00:00.000-05:00"

ISO 8601 format. Durations are in seconds (e.g., 900 = 15 min)

Developer Support

Our API team is here to help you build successful integrations. Whether you're troubleshooting an issue or planning a complex implementation, we provide technical guidance to keep your project moving forward.

Direct API SupportGet answers from engineers who built the API
Integration ReviewArchitecture feedback before you ship
Priority ResponseBusiness-critical issues handled first
Contact API Teamapi@alteg.io

Include request URL, headers, body, and response for faster resolution

Partner Program

Earn with Altegio

Connect clients to the platform and receive recurring commissions. Dedicated support, marketing materials, and API access included.

Learn more
Up to50%commission

What You Can Build

Popular integration scenarios powered by Altegio API

🗓️

Booking Widget

Embed scheduling into websites, mobile apps, or kiosks

🤖

AI Assistants

Let GPT, Claude or custom bots book appointments via API

📊

Analytics Dashboard

Build custom reports, BI integrations, data warehouses

🔄

CRM Sync

Two-way sync with Salesforce, HubSpot, custom CRMs

📱

White-label Apps

Build branded booking apps for your clients

💳

POS Integration

Connect payments, receipts, fiscal printers

📦

Inventory Automation

Sync stock levels with suppliers, e-commerce

🔔

Custom Notifications

Webhooks for real-time events, custom messaging

Core Entities

The API allows you to work with most of the platform's entities. Note that there are inconsistencies in the technical terminology: method and variable names may differ between the user interface and the documentation

Locations

A Location is an individual business unit that operates within the platform. Each Location belongs to a Chain. For single-location businesses, the platform still creates a single-location Chain.

Learn more →Also known as: company, branch, filial, salon

Chains

A Chain is a group of multiple Locations managed as a single business network. Chain-level settings, promotions, service catalogs, and loyalty rules may be inherited by all child Locations while each Location can still override them where needed.

Learn more →Also known as: groups, networks, salon_groups

Users

A User is an account that provides authenticated access to one or more Locations. Access scope is defined by Roles, which are predefined sets of Access Rights. If a User does not have access to a module or method, the API returns HTTP 403. Users can also be linked to Chains for Chain-level requests. Most API methods require the User to be authorised and to have explicit access to the target Location.

Learn more →Also known as: account, login

Team Members and Positions

A Team Member is an individual within a Location who participates in operational processes: provides Services within Appointments, creates or manages reservations, or works with financial and analytical data. Positions are logical groups of Team Members (similar to folders) that help structure staff by departments, functions, or specialisation.

Learn more →Also known as: employee, staff, staff_member, master

Resources

Resources are limited items required to provide Services (rooms, chairs, devices, machines). A Resource cannot be used in parallel for multiple Appointments; it is reserved when a Service linked to that Resource is booked.

Learn more →Also known as: equipment, room

Schedule & Time Slots

A Schedule is a set of time intervals during which a Team Member or Resource is available to provide Services. A Time Slot is a specific available interval within the Schedule that can be booked online for an Appointment with a Team Member.

Learn more →Also known as: timetable, availability

Appointments & Visits

An Appointment is a scheduled time interval during which a specific Team Member provides one or more Services or sells Products to a specific Client. A Visit is a group of one or more Appointments that take place during a single Client presence at a Location. Grouping rules depend on the Location settings.

Learn more →Also known as: record, booking

Events

An Event is a scheduled time slot for a group Service where multiple Clients can book simultaneously. Unlike individual Appointments, an Event has a capacity limit defining the maximum number of participants. Events are used for group classes, workshops, webinars, and any service that can serve multiple Clients at the same time.

Learn more →Also known as: activity, group event

Clients

A Client is an individual who books, receives, or has received Services or Products from a Location. Client data is used for scheduling, communication, and analytics.

Learn more →Also known as: customer, visitor

Services and Service Categories

A Service is a predefined type of work or procedure that can be provided to a Client by a Team Member within a Location. Each Service has key parameters such as duration, price (or price range), and applicable resources. Service Categories are logical groups used to organise Services for configuration, reporting, and client-facing catalogs.

Learn more →Also known as: treatments, procedures

Products and Product Categories

A Product is a tangible or consumable item that can be sold to a Client or used as part of a Service. Product Categories are logical groups used to organise Products for inventory management, reporting, and sales operations.

Learn more →Also known as: goods, items

Inventories

Inventories represent physical or logical Warehouses used to store and track Products and consumables. Inventory operations (receipts, write-offs, transfers) ensure that product usage in Visits is reflected in stock levels and financial reports.

Learn more →Also known as: storages, warehouses

Suppliers

Suppliers and Partners are counterparties used in Inventory and Finance modules to track product purchases, settlements, and mutual transactions with external companies.

Learn more →Also known as: partners, vendors

Location Accounts

Location Accounts are accounts (cash registers or bank accounts) attached to a specific Location. They are used to record payments for Visits, product sales, and other financial operations, and they define how money flows are grouped in financial reports.

Learn more →Also known as: cashdesks, cash registers

Payment Methods

Payment methods define how payments are recorded in the system (cash, card, bank transfer, online acquiring, loyalty instruments). Each method is linked to specific Accounts and can have its own commission and reporting logic.

Learn more →Also known as: payment types

Payroll Rules

Payroll rules define how staff compensation is calculated based on Visits, Products, Memberships, tips, and other metrics. They describe commission schemes, fixed payments, and deductions.

Learn more →Also known as: salary, wages

Client Cards

A Client Card is a unified profile that stores balances, active memberships, certificates, and participation in loyalty programs for a specific Client across one Location or an entire Chain.

Learn more →Also known as: loyalty cards

Memberships and their Types

A Membership is a prepaid product that gives a Client the right to receive a set number of services or discounts over a defined period. Membership Types define the rules: which services are included, how many visits are available, validity period, and usage restrictions.

Learn more →Also known as: abonements, passes

Certificates and their Types

A Certificate is a prepaid value or service voucher that can be used to pay for Services and Products. Certificate Types define how certificates are sold, accounted for, and redeemed, including validity period and usage restrictions.

Learn more →Also known as: gift cards, vouchers

Loyalty Programs

Loyalty programs combine bonus accrual, cumulative discounts and referral promotions to increase repeat visits and average spend. Any loyalty instrument must be linked to a specific Client Card so that bonuses, discounts, and balances are applied consistently across Visits.

Learn more →Also known as: rewards, bonuses

Client Accounts

Client Accounts are internal balances (deposits) stored on the Client Card. They are used to prepay future Visits, store overpayments, or keep store credit that can be partially or fully redeemed in subsequent Visits and sales.

Learn more →Also known as: deposits

Subdivisions

Subdivisions are higher-level groups used to organise Services across a Chain (for example, "Hair", "Nails", "Spa"). They help structure large catalogs, simplify analytics, and control visibility of Services in online booking.

Learn more →Also known as: departments

Custom Fields

Custom fields are additional attributes configured by the Location to store extra data in Visits or other entities (for example, medical notes, internal IDs). They extend the standard schema without changing the core data model.

Learn more →Also known as: additional fields

Tags

Tags allow users to group Clients, Appointments, or Events. They are used for analytics, targeted communications, and certain loyalty scenarios.

Learn more →Also known as: labels, segments, categories

Integrations HUB

Integrations HUB is a catalog of external applications and services connected to Altegio (telephony, messaging, CRM, loyalty, etc.). It standardises how integrations are discovered, installed, configured, and monetised.

Learn more →Also known as: marketplace, apps

Ready to Start Building?

Get your API key and start integrating in minutes