Skip to content
/
Edit Appointment

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 an Appointment

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

record_idnumberrequired

Appointment ID

Query
include_consumablesnumber
include_finance_transactionsnumber
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/record/{location_id}/{record_id}?include_consumables=0&include_finance_transactions=0' \
  -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: {"id":2,"company_id":4564,"staff_id":9,"services":[{"id":1,"title":"Hair extension","cost":100,"manual_cost":100,"cost_per_unit":100,"discount":0,"first_cost":100,"amount":1}],"goods_transactions":[],"staff":{"id":9,"name":"Alex Taylor","specialization":"hair extension","position":{"id":1,"title":"Administrator"},"avatar":"http://app.alteg.io/images/no-master-sm.png","avatar_big":"http://app.alteg.io/images/no-master.png","rating":0,"votes_count":0},"client":{"id":18936825,"name":"lx","phone":"+13155550175","card":"","email":"client@example.com","success_visits_count":37,"fail_visits_count":3},"clients_count":1,"date":"2026-09-21T23:00:00.000-05:00","datetime":"2026-09-21T23:00:00.000-05:00","create_date":"2026-01-17T19:41:44-0500","comment":"do not write down","visit_attendance":0,"attendance":0,"confirmed":1,"seance_length":3600,"length":3600,"sms_before":0,"sms_now":0,"sms_now_text":"","email_now":0,"notified":0,"master_request":0,"api_id":"","from_url":"","review_requested":0,"visit_id":8263004,"created_user_id":1073232,"deleted":false,"paid_full":0,"prepaid":false,"prepaid_confirmed":false,"last_change_date":"2026-01-17T19:44:14-0500","custom_color":"f44336","custom_font_color":"#ffffff","record_labels":[{"id":67345,"title":"the team member is not important","color":"#009800","icon":"unlock","font_color":"#ffffff"},{"id":104474,"title":"interesting category","color":"#3b2c54","icon":"star","font_color":"#ffffff"}],"activity_id":0,"custom_fields":{},"documents":[{"id":8172893,"type_id":7,"storage_id":0,"user_id":1073232,"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"}],"sms_remain_hours":5,"email_remain_hours":1,"bookform_id":0,"record_from":"","is_mobile":0,"is_sale_bill_printed":false,"consumables":[{"id":2173068,"document_id":8174153,"type_id":2,"company_id":4564,"good_id":4853087,"amount":-1,"cost_per_unit":0.03,"discount":0,"cost":0.03,"unit_id":216761,"operation_unit_type":2,"storage_id":91548,"supplier_id":0,"client_id":0,"master_id":0,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"","service_id":1,"user_id":1073232,"deleted":false,"pkg_amount":0}],"finance_transactions":[{"id":6024243,"document_id":8174152,"date":"2026-09-21T23:00:00.000-05:00","type_id":5,"expense_id":5,"account_id":90459,"amount":100,"client_id":18936825,"master_id":0,"supplier_id":0,"comment":"","item_id":1,"target_type_id":1,"record_id":2,"goods_transaction_id":0,"expense":{"id":5,"title":"Provision of services"},"account":{"id":90459,"title":"Main location account"},"client":{"id":18936825,"name":"lx","phone":"+13155550175"},"master":[],"supplier":[]}]}
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": {
    "id": 2,
    "company_id": 4564,
    "staff_id": 9,
    "services": [ … ],
    "goods_transactions": [],
    "staff": { … },
    "client": { … },
    "clients_count": 1,
    "date": "2026-09-21T23:00:00.000-05:00",
    "datetime": "2026-09-21T23:00:00.000-05:00",
    "create_date": "2026-01-17T19:41:44-0500",
    "comment": "do not write down",
    "visit_attendance": 0,
    "attendance": 0,
    "confirmed": 1,
    "seance_length": 3600,
    "length": 3600,
    "sms_before": 0,
    "sms_now": 0,
    "sms_now_text": "",
    "email_now": 0,
    "notified": 0,
    "master_request": 0,
    "api_id": "",
    "from_url": "",
    "review_requested": 0,
    "visit_id": 8263004,
    "created_user_id": 1073232,
    "deleted": false,
    "paid_full": 0,
    "prepaid": false,
    "prepaid_confirmed": false,
    "last_change_date": "2026-01-17T19:44:14-0500",
    "custom_color": "f44336",
    "custom_font_color": "#ffffff",
    "record_labels": [ … ],
    "activity_id": 0,
    "custom_fields": [],
    "documents": [ … ],
    "sms_remain_hours": 5,
    "email_remain_hours": 1,
    "bookform_id": 0,
    "record_from": "",
    "is_mobile": 0,
    "is_sale_bill_printed": false,
    "consumables": [ … ],
    "finance_transactions": [ … ]
  },
  "meta": []
}

Edit Appointment

Request

When an appointment is changed in a group event, the event_id parameter becomes required, staff_id, services, datetime, session_length parameters become optional

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

record_idnumberrequired

Appointment ID

Query
include_consumablesnumber
include_finance_transactionsnumber
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
staff_idnumber

team member ID

Example: 8886
servicesArray of objects

Service parameters (id, cost, discount)

Example: [{"id":331,"first_cost":9000,"discount":50,"cost":4500},{"id":333,"first_cost":2000,"discount":10,"cost":1800}]
clientobject

Client parameters (phone, name, email)

Example: {"phone":"+13155550175","name":"James Smith","email":"j.smith@example.com"}
save_if_busyboolean

Whether to keep the appointment if the time is busy or non-working, or give an error

datetimestring(date-time)

Date and time of appointment

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

Appointment duration in seconds

Example: 3600
send_smsboolean

Whether to send SMS with the details of the appointment to the client

Example: true
commentstring

Appointment Comment

Example: "test appointment!"
sms_remain_hoursnumber

Specifies how many hours before the visit an SMS reminder should be sent to the client. Set to 0 if no reminder is needed.

Example: 6
email_remain_hoursnumber

Specifies how many hours before the visit an email reminder should be sent to the client. Set to 0 if no reminder is needed.

Example: 24
attendancenumber

Appointment status (2 - User confirmed the appointment, 1 - User came, services provided, 0 - user waiting, -1 - user did not show)

Example: 1
api_idstring

External system ID

Example: "777"
custom_colorstring

Appointment color

Example: "f44336"
record_labelsArray of strings

Array of post category IDs

Example: ["67345","104474"]
technical_break_durationnumber or null

Technical break duration in seconds.

  • Must be in multiples of 300 (5-minute intervals)
  • Maximum value is 3600 (1 hour)
  • If null or not provided, uses location default from Settings → Appointment Log → Technical Breaks
One of:

Technical break duration in seconds.

  • Must be in multiples of 300 (5-minute intervals)
  • Maximum value is 3600 (1 hour)
  • If null or not provided, uses location default from Settings → Appointment Log → Technical Breaks
[ 0 .. 3600 ]
number[ 0 .. 3600 ]
custom_fieldsobject

Custom appointment fields

Example: {"my_custom_field":123,"some_another_field":["first value","second value"]}
curl -i -X PUT \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/record/{location_id}/{record_id}?include_consumables=0&include_finance_transactions=0' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "staff_id": 8886,
    "services": [
      {
        "id": 331,
        "first_cost": 9000,
        "discount": 50,
        "cost": 4500
      },
      {
        "id": 333,
        "first_cost": 2000,
        "discount": 10,
        "cost": 1800
      }
    ],
    "client": {
      "phone": "+13155550175",
      "name": "James Smith",
      "email": "j.smith@example.com"
    },
    "save_if_busy": false,
    "datetime": "2026-09-21T23:00:00.000-05:00",
    "seance_length": 3600,
    "send_sms": true,
    "comment": "test appointment!",
    "sms_remain_hours": 6,
    "email_remain_hours": 24,
    "attendance": 1,
    "api_id": "777",
    "custom_color": "f44336",
    "record_labels": [
      "67345",
      "104474"
    ],
    "custom_fields": {
      "my_custom_field": 123,
      "some_another_field": [
        "first value",
        "second value"
      ]
    }
  }'

Responses

Created

Bodyapplication/json
successboolean

Success status (true)

Example: true
dataobject

Object with data

Example: {"id":999,"services":[{"id":331,"first_cost":9000,"discount":50,"cost":4500},{"id":333,"first_cost":2000,"discount":10,"cost":1800}],"client":{"phone":"+13155550175","name":"James Smith","email":"j.smith@example.com"},"clients_count":1,"staff":{"id":8886,"name":"Alice Smith","spec":"stylist"},"datetime":"2026-09-21T23:00:00.000-05:00","seance_length":3600,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"test appointment!","visit_attendance":1,"confirmed":1,"sms_before":6,"sms_now":1,"sms_now_text":"","email_now":1,"notified":0,"master_request":1,"api_id":"","from_url":"","review_requested":0,"activity_id":0,"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": {
    "id": 999,
    "services": [ … ],
    "client": { … },
    "clients_count": 1,
    "staff": { … },
    "datetime": "2026-09-21T23:00:00.000-05:00",
    "seance_length": 3600,
    "create_date": "2026-09-21T23:00:00.000-05:00",
    "comment": "test appointment!",
    "visit_attendance": 1,
    "confirmed": 1,
    "sms_before": 6,
    "sms_now": 1,
    "sms_now_text": "",
    "email_now": 1,
    "notified": 0,
    "master_request": 1,
    "api_id": "",
    "from_url": "",
    "review_requested": 0,
    "activity_id": 0,
    "documents": [ … ]
  },
  "meta": []
}

Delete Appointment

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

record_idnumberrequired

Appointment ID

Query
include_consumablesnumber
include_finance_transactionsnumber
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 DELETE \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/record/{location_id}/{record_id}?include_consumables=0&include_finance_transactions=0' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

No Content

Response
No content

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