Skip to content
/
Book Event

Online Booking (1.0.0)

Public API for client-facing online booking integration. This API enables third-party developers to embed online booking functionality into external platforms such as business catalogs, branded apps, and partner services. Base URL: https://api.alteg.io/api

Authentication

All requests require partner authorization via Bearer token in the HTTP header: Authorization: Bearer <partner_token> To obtain a partner token, register in the Altegio Marketplace.

Rate Limits

  • 200 requests per minute per IP address - 5 requests per second per IP address
Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Altegio API Agreement
Terms of Service
Languages
Servers
Mock server
https://developer.alteg.io/_mock/en/public/openapi/
Production server
https://api.alteg.io/api/v1/

Authentication

User authentication and verification endpoints for online booking

Operations

Online Booking

Endpoints for booking form, services, staff, availability, and appointment management

Operations

Change Online Booking Date/Time

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

record_idnumberrequired

ID of the appointment to be migrated

Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example: application/vnd.api.v2+json
Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token

Bodyapplication/jsonrequired
datetimestring(date-time)

Date and time to which we want to move the appointment

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

Appointment Comment

Example: "DODO!"
curl -i -X PUT \
  'https://developer.alteg.io/_mock/en/public/openapi/book_record/{location_id}/{record_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "datetime": "2026-09-21T23:00:00.000-05:00",
    "comment": "DODO!"
  }'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataobject

Data (object)

Example: {"id":30358,"services":[{"id":2838,"title":"Foot massage","cost":0,"discount":0}],"company":{"id":4564,"title":"Business Example","country_id":0,"country":"United States","city_id":0,"city":"New York","phone":"+13155550175","timezone":"0","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242},"staff":{"id":924,"name":"Evgenia","spec":"about eu","show_rating":1,"rating":5,"votes_count":1,"avatar":"https://app.alteg.io/images/no-master.png","comments_count":0},"date":"2026-09-21T23:00:00.000-05:00","create_date":"2026-09-21T23:00:00.000-05:00","comment":"","deleted":true,"length":3600,"notify_by_sms":0,"notify_by_email":0,"master_requested":false,"online":true,"api_id":0}
Response
application/json
{
  "success": true,
  "data": {
    "id": 30358,
    "services": [ … ],
    "company": { … },
    "staff": { … },
    "date": "2026-09-21T23:00:00.000-05:00",
    "create_date": "2026-09-21T23:00:00.000-05:00",
    "comment": "",
    "deleted": true,
    "length": 3600,
    "notify_by_sms": 0,
    "notify_by_email": 0,
    "master_requested": false,
    "online": true,
    "api_id": 0
  }
}

Book Event

Request

Security
BearerPartner
Path
location_idnumberrequired

location ID

event_idintegerrequired

Event ID

Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example: application/vnd.api.v2+json
Content-Typestringrequired

application/json

Body*/*required
fullnamestringrequired

Client name

Example: "James Smith"
phonestringrequired

Customer phone (for example +13155550175)

Example: "+13155550175"
emailstringrequired

Postal address of the client

Example: "j.smith@example.com"
codenumber

SMS confirmation code for verifying the phone number. This field is required if the location has phone_confirmation = true

commentstring

Appointment Comment

notify_by_smsinteger(int32)

Specifies how many hours in advance an SMS reminder should be sent before the appointment. Set to 0 to disable SMS reminders.

notify_by_emailinteger(int32)

Specifies how many hours in advance an email reminder should be sent before the appointment. Set to 0 to disable email reminders

typestring

Appointment source

Example: "mobile"
api_idnumber

Appointment ID from external system

clients_countnumber

number of seats

curl -i -X POST \
  'https://developer.alteg.io/_mock/en/public/openapi/activity/{location_id}/{event_id}/book' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataobject

Object with data

Example: {"id":28417878,"hash":"9e6a54a1a9b118b65cc39ab6f3c3b5b4"}
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": {
    "id": 28417878,
    "hash": "9e6a54a1a9b118b65cc39ab6f3c3b5b4"
  },
  "meta": []
}

Get location privacy policy for online booking

Request

Retrieves the privacy policy configured for a specific location. This endpoint should be called before creating an online booking record to check if the location has a custom privacy policy.

If a location has a custom privacy policy configured, the online booking flow must:

  • Display the policy text to the user
  • Show a checkbox for accepting the privacy policy
  • Only proceed with booking creation after the user has checked the acceptance checkbox

If no custom policy is configured for the location, the booking can proceed without showing any policy acceptance step.

Security
BearerPartner
Path
location_idnumberrequired

location ID

Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example: application/vnd.api.v2+json
Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/public/openapi/privacy_policy/{location_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
Response
application/json
{
  "success": true,
  "data": {
    "agreement": { … }
  },
  "meta": []
}

Client Personal Cabinet

Client account management and booking history

Operations