Skip to content
/
Create a Booking Widget

Business Management (1.0.0)

Full-featured B2B API for business operations.

Base URL: https://api.alteg.io/api

⚠️ Version Status

V1 will be gradually deprecated. We recommend using V2 API for new integrations. V1 endpoints are maintained for backward compatibility, but new features will be released in V2 only.

Authentication

Requires both partner and user authorization:

Authorization: Bearer <partner_token>, User <user_token>
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/b2b-v1/openapi/
Production
https://api.alteg.io/api/v1/

Authentication B2B

User authentication and session management for B2B integrations

Operations

Locations

Manage business locations (salons, clinics, etc.)

Operations

Services

Service catalog management including categories and team member assignments

Operations

Team Members

Staff management including positions and scheduling

Operations

Clients

Client database management with comments, files, and visit history

Operations

Users & Permissions

User account management and role-based access control

Operations

Appointments

Booking records and visit management

Operations

Events

Group events and class management

Operations

Schedule & Resources

Timetables, schedules, and resource allocation

Operations

Products

Product catalog and categories

Operations

Inventory

Stock management, storage operations, and tech cards

Operations

Sales

Sales transactions and document management

Operations

Payments

Payment processing, accounts, and KKM transactions

Operations

Notifications

SMS and email notifications to clients

Operations

Online Booking Settings

Configure online booking behavior and forms

Operations

Get a list of booking widgets

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Headers
Acceptstringrequired

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

Authorizationstringrequired

Bearer partner_token, User user_token

Content-Typestringrequired

application/json

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/booking_forms' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

List of letterforms

Bodyapplication/json
dataArray of objects(bookform_settings_response)required

Array of data

data[].​ab_test_enabledbooleanrequired

Flag for enabling letterform ab-test

data[].​button_animationbooleanrequired

Button animation enable flag

data[].​button_colorstringrequired

Button color

data[].​button_positionstringrequired

Button location on the page

data[].​datetime_step_numnumberrequired

Sequence number of date and time

data[].​descriptionstringrequired

appointment widget description

data[].​form_positionstringrequired

Panel position on the page

data[].​html_codestringrequired

Code for inserting a button on the site

data[].​idnumberrequired

appointment widget ID

data[].​is_defaultbooleanrequired

Default appointment widget flag

data[].​master_step_defaultnumberrequired

team member ID

data[].​master_step_hidebooleanrequired

team member hide flag

data[].​master_step_numnumberrequired

Team Member serial number

data[].​service_step_defaultnumberrequired

Service ID

data[].​service_step_hidebooleanrequired

Service Hiding Flag

data[].​service_step_numnumberrequired

Service serial number

data[].​show_buttonbooleanrequired

Button Visibility Step

data[].​titlestringrequired

Name of the appointment widget

data[].​without_menubooleanrequired

Step mode flag

data[].​is_chainboolean

Chain booking form flag

data[].​sequence_typestring

Sequence type (e.g., "steps")

data[].​service_step_titlestring

Service step title

data[].​master_step_titlestring

Team member step title

data[].​specialization_display_modenumber

Specialization display mode

data[].​datetime_step_titlestring

Date/time step title

data[].​html_code_v2string

Version 2 of HTML code for button insertion

data[].​map_typenumber

Map type identifier

data[].​default_language_idnumber

Default language ID

data[].​group_idnumber

Group ID

data[].​facebook_pixel_idstring

Facebook Pixel ID

data[].​vk_pixel_idstring

VK Pixel ID

data[].​online_sales_group_idnumber

Online sales group ID

data[].​service_step_category_view_typestring

Service step category view type (e.g., "horizontal_tags")

data[].​salon_select_type_codestring

Location select type code (e.g., "list")

data[].​record_type_idnumber or null

Appointment type ID

data[].​display_activity_typestring

Display event type (e.g., "all")

data[].​is_multiple_activity_recordboolean

Multiple event appointment flag

data[].​activity_record_countnumber

Event appointment count limit

data[].​header_imagesobject or null

Header images configuration

data[].​is_weekly_view_enabledboolean

Weekly view enabled flag

data[].​show_weekly_view_without_online_bookingboolean

Show weekly view without online booking flag

data[].​weekly_view_default_salon_idnumber or null

Default location ID for weekly view

metaobjectrequired

Metadata (contains the total count of bookforms)

meta.​countnumber

Total count of booking forms

successbooleanrequired

Success status (true)

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

Create a Booking Widget

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Headers
Acceptstringrequired

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

Authorizationstringrequired

Bearer partner_token, User user_token

Content-Typestringrequired

application/json

Bodyapplication/jsonrequired
titlestringrequired

Name of the appointment widget

descriptionstring

appointment widget description

Default ""
is_defaultboolean

Default appointment widget flag

Default false
without_menuboolean

Step mode flag

Default false
service_step_defaultnumber

Service ID

service_step_hideboolean

Service Hiding Flag

Default false
master_step_defaultnumber

team member ID

master_step_hideboolean

team member hide flag

Default false
service_step_numnumber

Service step sequence number

master_step_numnumber

Sequence number of the wizard step

datetime_step_numnumber

Sequence number of the date and time step

show_buttonboolean

Button visibility flag

Default true
button_positionstring

Button location on the page

Default "bottom right"
Enum"bottom right""bottom left""top right""top left "
form_positionstring

Panel position on the page

Default "right"
Enum"right""left"
button_colorstring

Button color

Default "#1c84c6"
button_animationboolean

Button animation enable flag

Default true
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/booking_forms' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "description": "",
    "is_default": false,
    "without_menu": false,
    "service_step_default": 0,
    "service_step_hide": false,
    "master_step_default": 0,
    "master_step_hide": false,
    "service_step_num": 0,
    "master_step_num": 0,
    "datetime_step_num": 0,
    "show_button": true,
    "button_position": "bottom right",
    "form_position": "right",
    "button_color": "#1c84c6",
    "button_animation": true
  }'

Responses

appointment Widget Settings

Bodyapplication/json
dataobject(bookform_settings_response)required

appointment Widget Settings

data.​ab_test_enabledbooleanrequired

Flag for enabling letterform ab-test

data.​button_animationbooleanrequired

Button animation enable flag

data.​button_colorstringrequired

Button color

data.​button_positionstringrequired

Button location on the page

data.​datetime_step_numnumberrequired

Sequence number of date and time

data.​descriptionstringrequired

appointment widget description

data.​form_positionstringrequired

Panel position on the page

data.​html_codestringrequired

Code for inserting a button on the site

data.​idnumberrequired

appointment widget ID

data.​is_defaultbooleanrequired

Default appointment widget flag

data.​master_step_defaultnumberrequired

team member ID

data.​master_step_hidebooleanrequired

team member hide flag

data.​master_step_numnumberrequired

Team Member serial number

data.​service_step_defaultnumberrequired

Service ID

data.​service_step_hidebooleanrequired

Service Hiding Flag

data.​service_step_numnumberrequired

Service serial number

data.​show_buttonbooleanrequired

Button Visibility Step

data.​titlestringrequired

Name of the appointment widget

data.​without_menubooleanrequired

Step mode flag

data.​is_chainboolean

Chain booking form flag

data.​sequence_typestring

Sequence type (e.g., "steps")

data.​service_step_titlestring

Service step title

data.​master_step_titlestring

Team member step title

data.​specialization_display_modenumber

Specialization display mode

data.​datetime_step_titlestring

Date/time step title

data.​html_code_v2string

Version 2 of HTML code for button insertion

data.​map_typenumber

Map type identifier

data.​default_language_idnumber

Default language ID

data.​group_idnumber

Group ID

data.​facebook_pixel_idstring

Facebook Pixel ID

data.​vk_pixel_idstring

VK Pixel ID

data.​online_sales_group_idnumber

Online sales group ID

data.​service_step_category_view_typestring

Service step category view type (e.g., "horizontal_tags")

data.​salon_select_type_codestring

Location select type code (e.g., "list")

data.​record_type_idnumber or null

Appointment type ID

data.​display_activity_typestring

Display event type (e.g., "all")

data.​is_multiple_activity_recordboolean

Multiple event appointment flag

data.​activity_record_countnumber

Event appointment count limit

data.​header_imagesobject or null

Header images configuration

data.​is_weekly_view_enabledboolean

Weekly view enabled flag

data.​show_weekly_view_without_online_bookingboolean

Show weekly view without online booking flag

data.​weekly_view_default_salon_idnumber or null

Default location ID for weekly view

metaArray of objectsrequired

Metadata

successbooleanrequired

Success status (true)

Response
application/json
{
  "success": true,
  "data": {
    "id": 1,
    "title": "Name",
    "is_default": false,
    "description": "Description",
    "without_menu": false,
    "service_step_default": 0,
    "service_step_hide": false,
    "master_step_default": 0,
    "master_step_hide": false,
    "service_step_num": 2,
    "master_step_num": 1,
    "datetime_step_num": 3,
    "show_button": true,
    "button_position": "bottom right",
    "form_position": "right",
    "button_color": "#1c84c6",
    "button_animation": true,
    "html_code": "",
    "ab_test_enabled": false
  },
  "meta": []
}

Get a Booking Widget

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

form_idnumberrequired

appointment widget ID

Headers
Acceptstringrequired

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

Authorizationstringrequired

Bearer partner_token, User user_token

Content-Typestringrequired

application/json

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/booking_forms/{form_id}' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

appointment Widget Settings

Bodyapplication/json
dataobject(bookform_settings_response)required

appointment Widget Settings

data.​ab_test_enabledbooleanrequired

Flag for enabling letterform ab-test

data.​button_animationbooleanrequired

Button animation enable flag

data.​button_colorstringrequired

Button color

data.​button_positionstringrequired

Button location on the page

data.​datetime_step_numnumberrequired

Sequence number of date and time

data.​descriptionstringrequired

appointment widget description

data.​form_positionstringrequired

Panel position on the page

data.​html_codestringrequired

Code for inserting a button on the site

data.​idnumberrequired

appointment widget ID

data.​is_defaultbooleanrequired

Default appointment widget flag

data.​master_step_defaultnumberrequired

team member ID

data.​master_step_hidebooleanrequired

team member hide flag

data.​master_step_numnumberrequired

Team Member serial number

data.​service_step_defaultnumberrequired

Service ID

data.​service_step_hidebooleanrequired

Service Hiding Flag

data.​service_step_numnumberrequired

Service serial number

data.​show_buttonbooleanrequired

Button Visibility Step

data.​titlestringrequired

Name of the appointment widget

data.​without_menubooleanrequired

Step mode flag

data.​is_chainboolean

Chain booking form flag

data.​sequence_typestring

Sequence type (e.g., "steps")

data.​service_step_titlestring

Service step title

data.​master_step_titlestring

Team member step title

data.​specialization_display_modenumber

Specialization display mode

data.​datetime_step_titlestring

Date/time step title

data.​html_code_v2string

Version 2 of HTML code for button insertion

data.​map_typenumber

Map type identifier

data.​default_language_idnumber

Default language ID

data.​group_idnumber

Group ID

data.​facebook_pixel_idstring

Facebook Pixel ID

data.​vk_pixel_idstring

VK Pixel ID

data.​online_sales_group_idnumber

Online sales group ID

data.​service_step_category_view_typestring

Service step category view type (e.g., "horizontal_tags")

data.​salon_select_type_codestring

Location select type code (e.g., "list")

data.​record_type_idnumber or null

Appointment type ID

data.​display_activity_typestring

Display event type (e.g., "all")

data.​is_multiple_activity_recordboolean

Multiple event appointment flag

data.​activity_record_countnumber

Event appointment count limit

data.​header_imagesobject or null

Header images configuration

data.​is_weekly_view_enabledboolean

Weekly view enabled flag

data.​show_weekly_view_without_online_bookingboolean

Show weekly view without online booking flag

data.​weekly_view_default_salon_idnumber or null

Default location ID for weekly view

metaArray of objectsrequired

Metadata

successbooleanrequired

Success status (true)

Response
application/json
{
  "success": true,
  "data": {
    "id": 1,
    "title": "Name",
    "is_default": false,
    "description": "Description",
    "without_menu": false,
    "service_step_default": 0,
    "service_step_hide": false,
    "master_step_default": 0,
    "master_step_hide": false,
    "service_step_num": 2,
    "master_step_num": 1,
    "datetime_step_num": 3,
    "show_button": true,
    "button_position": "bottom right",
    "form_position": "right",
    "button_color": "#1c84c6",
    "button_animation": true,
    "html_code": "",
    "ab_test_enabled": false
  },
  "meta": []
}

Analytics & Reports

Business analytics, charts, and Z-reports

Operations

Tags

Label management for categorizing entities (deprecated, use v2)

Operations

Deposits

Client deposit accounts and operations

Operations

Loyalty Cards

Loyalty card types, issuance, and manual transactions

Operations

Subscriptions & Certificates

Membership subscriptions and gift certificates

Operations

Loyalty Programs

Discount programs, referral programs, and loyalty transactions

Operations

Salary

Staff salary calculations, payroll, and schemes

Operations

Notification Settings

Configure notification types and user preferences

Custom Fields

Custom field definitions for various entities

Operations

Chain Management

Multi-location chain operations and clients

Operations

Chain Loyalty Programs

Chain-level loyalty programs and transactions

Operations

Fiscalization

Tax system integration and KKM callbacks

Operations

Utilities

License info, phone validation, images, and tips

Operations