Skip to content
/
Get a visit

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

Get a List of Partner Appointments

Request

Filtering appointments

  • salon_id: Location ID

Use this to filter appointments for a specific location

  • start_date: Visit date from

Filters appointments with a visit date starting from the specified date (inclusive)

  • end_date: Visit date until

Filters appointments with a visit date up to the specified date (inclusive)

  • created_start_date: Appointment creation date from

Filters appointments created on or after this date

  • created_end_date: Appointment creation date until

Returns appointments created on or before this date

  • user_id: User ID

Filters appointments created by a specific user

Security
BearerPartnerUser
Query
pagenumber

Page number

Example: page=1
editable_lengthnumber

Number of appointments per page, maximum 100

Example: editable_length=50
salon_idnumber

Location ID

Example: salon_id=1
start_datestring

Filter by visit date from

Example: start_date='17.01.2025'
end_datestring

Filter by visit date by

Example: end_date='17.01.2025'
created_start_datestring

Filter by appointment creation date from

Example: created_start_date='17.01.2025'
created_end_datestring

Filter by appointment creation date by

Example: created_end_date='17.01.2025'
user_idnumber

User ID

Example: user_id=1
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/b2b-v1/openapi/records/partner?page=1&editable_length=50&salon_id=1&start_date=%2717.01.2025%27&end_date=%2717.01.2025%27&created_start_date=%2717.01.2025%27&created_end_date=%2717.01.2025%27&user_id=1' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

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

Get a visit

Request

Security
BearerPartnerUser
Path
visit_idnumberrequired
Example: 12345
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/b2b-v1/openapi/visits/12345 \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataobject

Object with data

Example: {"attendance":1,"datetime":"2026-09-21T23:00:00.000-05:00","comment":0,"records":[{"id":37955315,"company_id":4564,"staff_id":55436,"services":[],"events":[],"goods_transactions":[],"staff":{"id":55436,"name":"John Doe","specialization":"Manicure and pedicure","position":{"id":1,"title":"Supervisor"},"avatar":"https://app.alteg.io/uploads/masters/sm/b/bb/bb59d4cc17d9b16_20171215174158.png","avatar_big":"https://app.alteg.io/uploads/masters/origin/c/cf/cfb8c5cee58000b_20171215174158.png","rating":4.89,"votes_count":0},"client":{"id":4240788,"name":"dev1","phone":13155550175,"card":415,"email":"","success_visits_count":58,"fail_visits_count":9},"date":"2026-09-21T23:00:00.000-05:00","datetime":"2026-09-21T23:00:00.000-05:00","create_date":"2026-03-22T17:55:14-05:00","comment":"","online":false,"visit_attendance":1,"attendance":1,"confirmed":1,"seance_length":3600,"length":3600,"sms_before":1,"sms_now":1,"sms_now_text":"","email_now":1,"notified":0,"master_request":0,"api_id":"0","from_url":"","review_requested":0,"visit_id":8260852,"created_user_id":999290,"deleted":0,"paid_full":0,"prepaid":0,"prepaid_confirmed":0,"last_change_date":"2026-03-28T17:46:48-05:00","custom_color":"","custom_font_color":"","record_labels":[],"activity_id":0,"custom_fields":{},"documents":[{"id":8172893,"type_id":7,"storage_id":0,"user_id":746310,"company_id":4564,"number":4163,"comment":"","date_created":"2026-09-21T23:00:00.000-05:00","category_id":0,"visit_id":3,"record_id":2,"type_title":"Visit"}]}]}
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": {
    "attendance": 1,
    "datetime": "2026-09-21T23:00:00.000-05:00",
    "comment": 0,
    "records": [ … ]
  },
  "meta": []
}

Get Visit Details

Request

Block "kkm_transaction_details_container"

Flag "last_operation_type"

MeaningDescription
0Print return receipt
1Print sales receipt

Types of all transactions with location account

MeaningDescription
0Sales operation – Active for documents of type Visit
1Sale return operation – Active for documents of type Visit
2Correction operation
4Shift opening operation – Opens a new POS shift
5Shift closing operation – Closes the current POS shift
9Get POS status – Retrieves the current status of the POS device
11Get POS team status – Retrieves the status of all POS devices connected to the team
12Correction operation
13Print X-report – Prints a non-fiscal summary report of the current shift
6Cash deposit – Registers a cash-in transaction in the POS
7Cash withdrawal – Registers a cash-out transaction in the POS

Statuses of All POS Operations

MeaningDescription
0Connection error with POS – Unable to establish a connection with the POS device
1Success – Operation completed successfully
2Sent for printing – The request has been sent to the POS and is waiting for print completion
3Runtime error – An error occurred while processing the operation on the POS device
4Status check error – Failed to retrieve the current status of the POS
5Waiting for POS readiness – Operation is pending until the POS device becomes ready

Document Types

MeaningDescription
1Sale of products
2Provision of services
3Arrival of products
4Products write-off
5Transfer of products
6Inventory
7Visit
8Consumables write-off
Security
BearerPartnerUser
Path
location_idnumberrequired
Example: 12345
record_idnumberrequired
Example: 67890
visit_idnumberrequired
Example: 11111
Headers
Acceptstringrequired

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

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer access_token, User user_token

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

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataobject

Object with data

Example: {"payment_transactions":[{"id":6023813,"document_id":8172806,"date":"2026-09-21T23:00:00.000-05:00","type_id":5,"expense_id":5,"account_id":32299,"amount":10,"client_id":4241492,"master_id":0,"supplier_id":0,"comment":"","item_id":1162679,"target_type_id":1,"record_id":13136569,"goods_transaction_id":0,"expense":{"id":5,"title":"Provision of services"},"account":{"id":32299,"title":"Deposits (payment in cash)"},"client":{"id":4241492,"name":"ModulKassaClient","phone":"+13155550175"},"master":[],"supplier":[]}],"loyalty_transactions":[{"id":10614,"status_id":1,"amount":0.5,"type_id":2,"program_id":145,"card_id":20013,"salon_group_id":646,"item_id":0,"item_type_id":0,"item_record_id":0,"goods_transaction_id":0,"is_discount":false,"is_loyalty_withdraw":false,"type":{"id":2,"title":"Loyalty programs"}}],"kkm_transaction_details_container":{"last_operation_type":0,"transactions":[{"id":1047,"print_date":"2026-09-21T23:00:00.000-05:00","printed_count":1,"sum":13,"type":{"id":0,"title":"Sale operation"},"status":{"id":1,"title":"Successfully"},"document":{"id":2045,"type":7,"type_title":"Visit"},"cashier":{"id":746310,"name":"Jack Smith"}}]},"items":[{"id":0,"item_id":1162679,"item_type_id":1,"record_id":13136569,"item_title":"Haircut with the TOP-expert","amount":2,"first_cost":20,"manual_cost":10,"discount":50,"cost":10,"master_id":13136569,"good_id":0,"service_id":1162679,"event_id":0,"is_service":true,"is_event":false,"is_good":false}]}
metaArray of objects

Metadata (empty array)

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

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

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