Skip to content
/
Quick create a team membe...

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

Delete team member

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

team_member_idnumberrequired

team member 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 DELETE \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/staff/{location_id}/{team_member_id}' \
  -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

Quick create a team member

Request

Creates a new team member with a minimal set of parameters.

Security
BearerPartnerUser
Path
location_idnumberrequired

ID of a location.

Example: 123
Headers
Acceptstringrequired

Should be equal to application/vnd.api.v2+json

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

Should be equal to application/json

Example: application/json
Bodyapplication/json
namestringrequired

Name of a team member.

Example: "John Johnson"
specializationstringrequired

Specialization of a team member.

Example: "Cosmetologist"
position_idnumber or nullrequired

ID of a position that should be linked to a team member.

Example: 123
phone_numberstring or nullrequired

Phone number of a user that should be linked to a team member (without "+", 9 to 15 digits).

Example: 11234567890
user_emailstring(email)required

Email address of the user to be created or linked to the team member.

Example: "john.johnson@example.com"
user_phonestringrequired

User phone number (without "+", 9 to 15 digits). Can be the same as phone_number or different for user account login.

Example: 11234567890
is_user_invitebooleanrequired

Whether to send an invitation email to the user. Set to true to send invitation, false to create without sending invitation.

Example: false
curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/123/staff/quick \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "John Johnson",
    "specialization": "Cosmetologist",
    "position_id": 123,
    "phone_number": 11234567890,
    "user_email": "john.johnson@example.com",
    "user_phone": 11234567890,
    "is_user_invite": false
  }'

Responses

Created

Bodyapplication/json
successboolean(response_success_true_object)

Response status.

dataobject(master_with_position)
metaArray of objects or arrays or object(response_meta_empty_object)

Additional response data (empty object or empty array)

Response
application/json
{
  "success": true,
  "data": {
    "id": 123,
    "name": "John Johnson",
    "company_id": 123,
    "specialization": "Master",
    "avatar": "https://app.alteg.io/images/no-master-sm.png",
    "avatar_big": "https://app.alteg.io/images/no-master.png",
    "position": { … }
  },
  "meta": {}
}

Get Team Members / Specific Team Member

Request

Security
BearerPartnerUser
Path
location_idnumberrequired

Location ID

team_member_idnumberrequired

team member ID, if you need to work with a specific team member.

Headers
Acceptstringrequired

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/company/{location_id}/staff/{team_member_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 (true)

Example: true
dataobject

Team member data object

Example: {"id":1001539,"name":"team member 1","company_id":176275,"specialization":"team member","position":{"id":1,"title":"Administrator"},"avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master.png","fired":0,"status":0,"hidden":0,"user_id":12345}
metaArray of objects

Metadata (empty array)

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

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

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