Skip to content
/
Adding a Client

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

Adding a Client

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

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

Body*/*
namestringrequired

Client name

Example: "James"
phonestringrequired

Customer phone

Example: 13155550179
surnamestring

Client surname

Example: "Smith"
middle_namestring

Client middle name

Example: "James"
emailstring

Client Email

Example: "j.smith@example.com"
gender_idnumber

Gender of the client (1 - male, 2 - female, 0 - unknown)

Example: 1
importance_idnumber

Client priority level (0 - none, 1 - bronze, 2 - silver, 3 - gold)

Example: 1
discountnumber

Customer Discount

Example: 15
cardstring

Client card number

Example: 555888666
birth_datestring

Date of birth of the client in the format yyyy-mm-dd

Example: "952041600"
commentstring

A comment

Example: "throws show-off"
spentnumber

How much money spent in the location at the time of adding

Example: 1000
balancenumber

Client balance

Example: -200
sms_checknumber

1 - Happy Birthday by SMS, 0 - do not congratulate

sms_notnumber

1 - Exclude the client from SMS mailings, 0 - do not exclude

categoriesobject

Array of customer tag IDs

Example: [101,102]
custom_fieldsobject

Array of additional client fields as "api-key": "value" pairs

Example: {"key-1":"value-1"}
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/clients/{location_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

Created

Bodyapplication/json
Response
application/json
{
  "success": true,
  "data": {
    "id": 1121412,
    "name": "James",
    "surname": "Smith",
    "middle_name": "James",
    "phone": 13155550179,
    "email": "j.smith@example.com",
    "categories": [],
    "gender": "Male",
    "gender_id": 1,
    "discount": 15,
    "importance_id": 1,
    "importance": "Bronze",
    "card": 555888666,
    "birth_date": "952041600",
    "comment": "throws show-off",
    "sms_check": 0,
    "sms_not": 0,
    "spent": 1000,
    "balance": -1200,
    "visits": 0,
    "last_change_date": "2026-05-01T12:00:00-0500",
    "custom_fields": { … }
  },
  "meta": []
}

Get a list of clients

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Headers
Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Bodyapplication/jsonrequired
pagenumber

Page number

Example: 1
page_sizenumber

The number of output lines per page. Maximum 200. (Default 25)

Example: 3
fieldsArray of strings

Fields to be returned in the response

Example: ["id","name"]
order_bystring

What field to sort by

Enum"id""name""phone""email""discount""first_visit_date""last_visit_date""sold_amount""visit_count"
Example: "name"
order_by_directionstring

How to sort (ascending / descending)

Enum"ASC""DESC"
Example: "desc"
operationstring

Type of transaction

Enum"AND""OR"
Example: "AND"
filtersArray of objects

Filters for searching by customers

Example: [{"type":"id","state":{"value":[1,2,3]}},{"type":"sold_amount","state":{"from":0,"to":100.77}},{"type":"quick_search","state":{"value":"James Smith"}},{"type":"importance","state":{"value":[0,1,2,3]}},{"type":"has_mobile_app","state":{"value":true}},{"type":"category","state":{"value":[1,7]}},{"type":"has_passteam_card","state":{"value":true}},{"type":"passteam_card_ids","state":{"value":["111122223333aaaabbbbcccc"]}},{"type":"birthday","state":{"from":"1990-01-01 00:00:00","to":"2000-01-01 23:59:59"}},{"type":"gender","state":{"value":[0,1,2]}},{"type":"record","state":{"staff":{"value":[1,2]},"service":{"value":[2,3]},"service_category":{"value":[4,5]},"status":{"value":[1]},"created":{"from":"2026-01-01 00:00:00","to":"2026-01-01 23:59:59"},"records_count":{"from":1,"to":99999},"sold_amount":{"from":1.001,"to":99999.09}}},{"type":"client","state":{"id":{"value":[1,2,3]},"birthday":{"from":"1990-01-01 00:00:00","to":"2000-01-01 23:59:59"}}},{"type":"sale","state":{"abonement_balance":{"from":2,"to":3}}}]
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/clients/search' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "page": 1,
    "page_size": 3,
    "fields": [
      "id",
      "name"
    ],
    "order_by": "name",
    "order_by_direction": "desc",
    "operation": "AND",
    "filters": [
      {
        "type": "id",
        "state": {
          "value": [
            1,
            2,
            3
          ]
        }
      },
      {
        "type": "sold_amount",
        "state": {
          "from": 0,
          "to": 100.77
        }
      },
      {
        "type": "quick_search",
        "state": {
          "value": "James Smith"
        }
      },
      {
        "type": "importance",
        "state": {
          "value": [
            0,
            1,
            2,
            3
          ]
        }
      },
      {
        "type": "has_mobile_app",
        "state": {
          "value": true
        }
      },
      {
        "type": "category",
        "state": {
          "value": [
            1,
            7
          ]
        }
      },
      {
        "type": "has_passteam_card",
        "state": {
          "value": true
        }
      },
      {
        "type": "passteam_card_ids",
        "state": {
          "value": [
            "111122223333aaaabbbbcccc"
          ]
        }
      },
      {
        "type": "birthday",
        "state": {
          "from": "1990-01-01 00:00:00",
          "to": "2000-01-01 23:59:59"
        }
      },
      {
        "type": "gender",
        "state": {
          "value": [
            0,
            1,
            2
          ]
        }
      },
      {
        "type": "record",
        "state": {
          "staff": {
            "value": [
              1,
              2
            ]
          },
          "service": {
            "value": [
              2,
              3
            ]
          },
          "service_category": {
            "value": [
              4,
              5
            ]
          },
          "status": {
            "value": [
              1
            ]
          },
          "created": {
            "from": "2026-01-01 00:00:00",
            "to": "2026-01-01 23:59:59"
          },
          "records_count": {
            "from": 1,
            "to": 99999
          },
          "sold_amount": {
            "from": 1.001,
            "to": 99999.09
          }
        }
      },
      {
        "type": "client",
        "state": {
          "id": {
            "value": [
              1,
              2,
              3
            ]
          },
          "birthday": {
            "from": "1990-01-01 00:00:00",
            "to": "2000-01-01 23:59:59"
          }
        }
      },
      {
        "type": "sale",
        "state": {
          "abonement_balance": {
            "from": 2,
            "to": 3
          }
        }
      }
    ]
  }'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataArray of objects

Array of objects with data

Example: [{"name":"James Smith","id":2},{"name":"Taylor Reed","id":3},{"name":"James Smith","id":1}]
metaobject

Metadata (contains the number of clients found)

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

Get a client

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

idnumberrequired

Client ID

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/client/{location_id}/{id}' \
  -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": {
    "id": 16,
    "name": "James",
    "surname": "Smith",
    "middle_name": "James",
    "phone": 13155550178,
    "email": "",
    "categories": [],
    "gender": "unknown",
    "discount": 0,
    "importance": "No importance class",
    "card": "",
    "birth_date": null,
    "comment": "",
    "sms_check": 0,
    "sms_not": 0,
    "spent": 0,
    "balance": 0,
    "visits": 3,
    "last_change_date": "2026-03-01T12:00:00-0500",
    "custom_fields": []
  },
  "meta": []
}

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

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