Skip to content
/
Send SMS Verification Cod...

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

Client Personal Cabinet

Client account management and booking history

Operations

Update Online Booking User Password

Request

Updating the password of an online booking user.

The response comes with a new user token.

Security
BearerPartner
Headers
Acceptstringrequired

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

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

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Bodyapplication/jsonrequired
old_passwordstring

Current Password

Example: "qwerty123"
new_passwordstring

New password

Example: "example!"
curl -i -X PUT \
  https://developer.alteg.io/_mock/en/public/openapi/booking/user/password \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "old_password": "qwerty123",
    "new_password": "example!"
  }'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataobject

Object with data

Example: {"user_token":"4de9d8cc108c0"}
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": {
    "user_token": "4de9d8cc108c0"
  },
  "meta": []
}

Send SMS Verification Code for Phone Update

Request

The request must contain one of two parameters: company_id or group_id

Security
BearerPartner
Query
company_idintegerrequired

location ID

group_idintegerrequired

Chain ID

phonestringrequired

Phone number

Headers
Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/public/openapi/booking/user/phone_confirmation?company_id=0&group_id=0&phone=string' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

Accepted

Bodyapplication/json
Response
application/json
{
  "success": true,
  "meta": {
    "message": "Accepted"
  }
}

Get User Appointments

Request

The JSON Object containing the user appointment parameters has the following fields:

FieldTypeMandatoryDescription
idnumberYESAppointment ID
servicesarray of numbersYESList of ID service appointments
locationobjectYESlocation parameters
staffobjectYESParameters of the team member who was booked. Note: "staff" is a legacy field name for team member.
clients_countintYESNumber of clients
datestringYESSession date
datetimestringYESSession date in ISO
create_datestringYESAppointment creation date
lengthnumberYESSession duration
deletedbooleanYESHas the appointment been created ? (true if deleted)
notify_by_smsnumberNONumber of hours in advance to send an SMS reminder for the appointment. Set to 0 to disable SMS reminders
notify_by_emailnumberNONumber of hours in advance to send an email reminder for the appointment. Set to 0 to disable email reminders
commentstringYESAppointment Comment
master_requestedbooleanYESWhether a specific team member was specified when appointment (false if "any team member" was specified)
onlinebooleanYESIndicates whether the appointment was created online by the client (true) or manually by an administrator (false)
visit_attendancenumberYES2 - The user confirmed the appointment, 1 - The user came, the services were provided, 0 - the user was waiting, -1 - the user did not come to visit
api_idstringNOExternal Appointment ID
last_change_datestringNODate of the last edit of the appointment
prepaidbooleanNOIs online payment available for appointment
prepaid_confirmedbooleanNOOnline payment status
last_change_datestringNODate of the last edit of the appointment
activity_idintNOEvent ID (for group events)

Each object in the services array has the following fields:

FieldTypeDescription
idnumberService ID
titlestringService name
costfloatService cost
price_minfloatMinimum price of the service
price_maxfloatMaximum service price
discountfloatDiscount
amountintNumber of ordered services
session_lengthintService duration in seconds (only if filter by team member is set)

The location object has the following fields:

FieldTypeDescription
idnumberlocation ID
titlestringlocation name
country_idnumberIdentifier of the country in which the location is located
countrystringlocation name
city_idnumberIdentifier of the city where the location is located)
citystringlocation city name
time zonestringtimezone locations
addressstringAddress where the location is located
phonestringlocation's main phone number
phonesarray of stringsAll phone numbers of the location
coordinate_latfloatLatitude where the location is located
coordinate lngfloatLongitude
allow_delete_recordbooleanIs it possible to delete an appointment
allow_change_recordbooleanIs it possible to reschedule the appointment
sitestringlocation website
currency_short_titlestringCurrency symbol
allow_change_record_delay_stepintTime after which you can reschedule the appointment
allow_delete_record_delay_stepintTime after which you can delete an appointment

The team member object has the following fields:

FieldTypeDescription
idnumberteam member ID
namestringteam member name
specializationstringteam member specialization
positionobjectteam member position
show_ratingnumberWhether to show team member's rating (1 - show, 0 - don't show)
ratingnumberteam member rating
votes_countnumberNumber of votes rated team member
comments_countnumberNumber of comments to a team member
avatarstringPath to team member avatar file
Security
BearerPartner
Path
record_idnumberrequired

Appointment ID

Example: 22123
record_hashstringrequired

HASH of the appointment

Example: 'dawd4fs09rhf0s9fafef0'
Headers
Acceptstringrequired

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

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

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

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

Responses

Created

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataArray of objects

Array of objects

Example: [{"id":13132699,"services":[{"id":389043,"title":"Correction of extended nails","cost":2300,"price_min":2300,"price_max":2300,"discount":0,"amount":1,"seance_length":1800}],"company":{"id":4564,"title":"Nail studio","country_id":7,"country":"United States","city_id":2,"city":"New York","phone":"+13155550175","phones":[],"timezone":"-5","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"allow_delete_record":true,"allow_change_record":true,"site":"www.example.com","currency_short_title":"USD","allow_change_record_delay_step":0,"allow_delete_record_delay_step":0},"staff":{"id":55436,"name":"Natalie Parker","specialization":"Team Member in manicure and pedicure","position":{"id":446,"title":"Manicurist"},"show_rating":1,"rating":4.84,"votes_count":0,"avatar":"http://example.com/image.png","comments_count":37},"clients_count":1,"date":"2026-09-21T23:00:00.000-05:00","datetime":"2026-10-24T17:30:00-0500","create_date":"2026-10-20T21:40:24-0500","comment":"","deleted":true,"attendance":0,"length":1800,"notify_by_sms":0,"notify_by_email":0,"master_requested":false,"online":true,"api_id":"","last_change_date":"2026-10-24T23:54:02-0500","prepaid":false,"prepaid_confirmed":false,"activity_id":0},{"id":13133413,"services":[{"id":389045,"title":"Hand massage (10 min)","cost":300,"price_min":300,"price_max":400,"discount":0,"amount":1,"seance_length":1800}],"company":{"id":4564,"title":"Nail studio","country_id":7,"country":"United States","city_id":2,"city":"New York","phone":"+13155550175","phones":[],"timezone":"-5","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"allow_delete_record":true,"allow_change_record":true,"site":"www.example.com","currency_short_title":"USD","allow_change_record_delay_step":0,"allow_delete_record_delay_step":0},"staff":{"id":55436,"name":"Natalie Parker","specialization":"Team Member in manicure and pedicure","position":{"id":446,"title":"Manicurist"},"show_rating":1,"rating":4.84,"votes_count":0,"avatar":"http://example.com/image.png","comments_count":37},"clients_count":1,"date":"2026-09-21T23:00:00.000-05:00","datetime":"2026-10-24T17:30:00-0500","create_date":"2026-10-20T21:40:24-0500","comment":"","deleted":true,"attendance":0,"length":1800,"notify_by_sms":0,"notify_by_email":0,"master_requested":false,"online":true,"api_id":"","last_change_date":"2026-10-24T23:54:02-0500","prepaid":false,"prepaid_confirmed":false,"activity_id":0}]
metaArray of objects

Metadata (empty array)

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