Skip to content
/
Search available subscrip...

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

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

Get a List of Available Membership Types

Request

A list of membership types available at a location can be obtained by requesting the location ID. The list can be filtered by membership type name by passing the title parameter. Pagination is supported, specified by the page and page_size parameters.

The list is an array of membership types.

Membership type has the following structure:

FieldTypeDescription
idnumberMembership type identifier
titlestringMembership type name
allow_freezebooleanIs it possible to freeze memberships? true - allowed, false - not allowed
freeze limitnumberMaximum total freezing period (days)
salon_group_idnumberIdentifier of the chain in which the membership type is valid
periodnumberMembership expiration date (0 if not set)
period_unit_idnumberMembership expiration unit (list of possible values, if not set - 0)
is_allow_empty_codebooleanAllow the sale of a membership without a code? true - allow, false - do not allow
is_united_balancebooleanTotal or separate membership balance: true - total, false - separate
united_balance_services_countnumberNumber of visits for total balance

Measurement units of membership type validity period

MeaningDescription
1Day
2Week
3Month
4Year
Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Query
titlestring

Membeship type name

pagenumber

Page number

page_sizenumber

The number of output lines per page. Maximum 100

Headers
Acceptstringrequired

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

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

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/loyalty/abonement_types/search?title=string&page=0&page_size=0' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Conetnt-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataArray of objects

Array with data objects

Example: [{"id":12233,"salon_group_id":123,"title":"Subscription with the possibility of freezing for 14 days","period":0,"period_unit_id":0,"allow_freeze":true,"freeze_limit":14,"is_allow_empty_code":false,"is_united_balance":false,"united_balance_services_count":0},{"id":255789,"salon_group_id":456,"title":"Subscription for 6 months","period":6,"period_unit_id":3,"allow_freeze":false,"freeze_limit":0,"is_allow_empty_code":false,"is_united_balance":false,"united_balance_services_count":0}]
metaobject

Metadata (contains the number of membership types found)

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

Search available subscriptions for event

Request

Retrieves subscriptions that can be used to create a client schedule for a series of events.

This method returns subscriptions (memberships) that:

  • Belong to the specified client
  • Are valid and active
  • Can be applied to the specified activity
  • Have remaining visits available

Use cases:

  • Display available subscriptions when scheduling recurring activity sessions
  • Check which subscriptions cover specific activity types
  • Validate subscription applicability before creating schedules

Note: Returns subscriptions with their types and availability intervals.

Security
BearerPartner
Path
location_idintegerrequired

Location ID

Example: 720441
client_idintegerrequired

Client ID

Example: 146915197
Query
event_idintegerrequired

Event (group event) ID

Example: event_id=12345
Headers
Acceptstringrequired
Default application/vnd.api.v2+json
Content-Typestringrequired
Default application/json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/api/v1/company/720441/client/146915197/loyalty/abonements/search_for_activity?event_id=12345' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: application/json'

Responses

List of available subscriptions

Bodyapplication/json
dataArray of objects
includedArray of objects

Related membership types and availability intervals

Response
application/json
{
  "data": [
    { … }
  ],
  "included": [
    {}
  ]
}

Check membership availability for event

Request

Validates a specific subscription for creating activity schedules.

Returns:

  • Last possible appointment date based on membership expiration
  • Available visit count for the selected subscription
  • Schedule day IDs that can be booked

Use cases:

  • Validate subscription before creating recurring appointments
  • Check if subscription has enough visits for schedule
  • Determine last bookable date based on expiration
  • Pre-validate schedule parameters

Note: Requires schedule_day_ids parameter to check specific dates.

Security
BearerPartner
Path
location_idintegerrequired

Location ID

Example: 720441
client_idintegerrequired

Client ID

Example: 146915197
membership_idintegerrequired

Membership instance ID

Example: 5248829
Query
event_idintegerrequired

Event (group event) ID

Example: event_id=12345
schedule_day_idsstringrequired

Comma-separated list of schedule day IDs to check

Example: schedule_day_ids=1,2,3,4,5
Headers
Acceptstringrequired
Default application/vnd.api.v2+json
Content-Typestringrequired
Default application/json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/api/v1/company/720441/client/146915197/loyalty/abonements/5248829/check_for_activity?event_id=12345&schedule_day_ids=1%2C2%2C3%2C4%2C5' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: application/json'

Responses

Subscription availability information

Bodyapplication/json
dataobject
Response
application/json
{
  "data": {
    "id": "check_1",
    "type": "loyalty_abonement_check",
    "attributes": { … }
  }
}

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