Skip to content
/
Get notification settings...

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

Getting Message Statuses

Request

Get message statuses

NumberTitle
1Delivered
2Not delivered
4Sent to phone
8Transferred to the operator
16Rejected by operator
52Not enough funds

In the event of an error, the corresponding HTTP status code is returned. In some cases, a descriptive error message is also included in the response. The following error codes may be returned by all API methods:

error codeHttp status codeTitleDescription
5400ENTITY_VALIDATION_ERRORThe request body did not pass validation
10400FIELD_VALIDATION_ERRORParameter not validated
15403ACCESS_FORBIDDENThe action is not available, the application does not have the required permissions.
20401INVALID_PARTNER_TOKENpartner_token missing or invalid
30404RESOURCE_NOT_FOUNDThe resource at the requested path does not exist

When sending SMS, the delivery_callback_url attribute is passed in the request - this is the url to which message statuses should be sent.

Use it to send message statuses. Url to which message statuses should be sent - https://app.alteg.io/smsprovider/status/callback/{partner_token}

Security
BearerPartnerUser
Headers
Acceptstringrequired

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

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

application/json

Authorizationstringrequired

Bearer partner_token

Bodyapplication/jsonrequiredArray [
idstring

Identifier

statusnumber

Message status

payment_sumnumber

Full message cost

currency_isostring

Currency ISO

parts_amountnumber

Amount of message's parts

]
curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/delivery/status \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "id": "232674",
      "status": 1,
      "payment_sum": 0.045,
      "currency_iso": "EUR",
      "parts_amount": 2
    }
  ]'

Responses

OK

Bodyapplication/json
Response
application/json
{
  "success": true
}

Get notification settings in a location

Request

The method allows you to get notification settings in a location.

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Headers
Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer bearer_token, USer user_token

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

Responses

OK

Bodyapplication/json
successboolean

Execution success status

Example: true
dataArray of objects

Array of objects

Example: [{"type":"record_create_online_staff","channels":{"push":1,"sms":0,"email":1}},{"type":"record_move_admin","channels":{"push":1,"sms":0,"email":0}},{"type":"license_expire","channels":{"push":1,"sms":1,"email":1}},{"type":"record_create_offline_admin","channels":{"push":1,"sms":0,"email":1}},{"type":"record_create_offline_staff","channels":{"push":1,"sms":0,"email":0}},{"type":"record_create_online_admin","channels":{"push":1,"sms":0,"email":1}},{"type":"record_delete_admin","channels":{"push":0,"sms":0,"email":1}},{"type":"record_delete_staff","channels":{"push":1,"sms":0,"email":0}},{"type":"record_move_staff","channels":{"push":0,"sms":0,"email":0}}]
metaobject

Metadata (contains the number of objects)

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

Get User Notification Settings

Request

The method allows you to get notification settings for a particular location user.

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

user_idnumberrequired

User ID

Headers
Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer bearer_token, User user_token

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

Responses

OK

Bodyapplication/json
successboolean

Execution success status

Example: true
dataobject

Object with data

Example: {"mode":"staff","notification_types":[{"type":"record_create_online_staff","channels":{"push":1,"sms":0,"email":1}},{"type":"record_create_offline_staff","channels":{"push":1,"sms":0,"email":0}},{"type":"record_delete_staff","channels":{"push":0,"sms":0,"email":0}},{"type":"record_move_staff","channels":{"push":0,"sms":0,"email":0}},{"type":"license_expire","channels":{"push":0,"sms":0,"email":0}}]}
metaArray of objects

Metadata (empty array)

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

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