Skip to content
/
Change Online Booking Dat...

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

Get Online Booking Details

Request

Security
BearerPartner
Path
location_idnumberrequired

location ID

record_idnumberrequired

Post ID (enough to view the post if the user is logged in)

Example: 22123
record_hashstringrequired

HASH appointments (required to view the appointment if the user is not authorized)

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/book_record/{location_id}/22123/'\''dawd4fs09rhf0s9fafef0'\''' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
idnumber

Appointment ID

Example: 13132699
servicesArray of objects

Service ID List

Example: [{"id":389043,"title":"Correction of extended nails","cost":2300,"price_min":2300,"price_max":2300,"discount":0,"amount":1,"seance_length":1800}]
companyobject

location parameters

Example: {"id":4564,"title":"Nail studio","country_id":7,"country":"United States","city_id":2,"city":"New York","phone":"+13155550175","phones":[],"timezone":"12","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}
staffobject

team member parameters

Example: {"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_countinteger(int32)
Example: 1
datestring(date-time)

04-02T12:00:00Z' (required, string) - Session date

Example: "2026-09-21T23:00:00.000-05:00"
datetimestring(date-time)

Session date in ISO

Example: "2026-10-24T17:30:00-0500"
create_datestring(date-time)

04-02T12:00:00Z' (required, string) - Appointment creation date

Example: "2026-10-20T21:40:24-0500"
commentstring

Appointment Comment

deletedboolean

Whether the appointment was made (true if removed)

Example: true
attendancenumber

2 - the user confirmed the appointment, 1 - the user came, the services were provided, 0 - the user was waiting, -1 - the user did not show'

lengthnumber

Session duration

Example: 1800
notify_by_smsnumber

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

notify_by_emailnumber

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

master_requestedboolean

Indicates whether a specific team member was selected for the appointment. Set to false if the "any team member" option was chosen.

onlineboolean

Indicates whether the appointment was created online by the client (true) or manually by an administrator (false)

Example: true
api_idstring

External appointment ID

last_change_datestring(date-time)

The date and time when the appointment was last modified

Example: "2026-10-24T23:54:02-0500"
prepaidboolean

Indicates whether online payment is available for the appointment

prepaid_confirmedboolean

Online payment status

activity_idnumber

group event ID

Response
application/json
{
  "id": 13132699,
  "services": [
    { … }
  ],
  "company": {
    "id": 4564,
    "title": "Nail studio",
    "country_id": 7,
    "country": "United States",
    "city_id": 2,
    "city": "New York",
    "phone": "+13155550175",
    "phones": [],
    "timezone": "12",
    "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": { … },
    "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
}

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": []
}

Client Personal Cabinet

Client account management and booking history

Operations