Skip to content
/
Get a List of Gift Card T...

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 user gift cards

Request

Returns a list of authorized user gift cards

Security
BearerPartner
Query
company_idnumberrequired

Location ID

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/user/loyalty/certificates?company_id=0' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataArray of objects

Array of objects with data

Example: [{"id":409726,"number":888,"balance":9000,"default_balance":9000,"type_id":27841,"status_id":2,"created_date":"2026-09-21T23:00:00.000-05:00","expiration_date":"2026-09-21T23:00:00.000-05:00","type":{"id":27841,"title":"certificate 9000","balance":9000,"is_multi":true,"company_group_id":128284,"item_type_id":0,"expiration_type_id":2,"expiration_timeout":365,"expiration_timeout_unit_id":1,"is_allow_empty_code":false,"item_type":{"id":0,"title":"No limits"}},"status":{"id":2,"title":"activated"}}]
metaobject

Metadata (contains the number of certificates found)

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

Get a List of Gift Card Types by ID

Request

A list of gift card types available at the location can be obtained by querying the location ID and gift card type IDs.

The list is an array of gift card types.

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

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/loyalty/certificate_types/fetch' \
  -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
dataArray of objects

Array of objects with data

Example: [{"id":1,"title":"Fixed burn date certificate without application restrictions","balance":10,"is_multi":true,"company_group_id":12,"item_type_id":0,"expiration_type_id":1,"expiration_date":"2026-09-21T23:00:00.000-05:00","expiration_timeout":0,"expiration_timeout_unit_id":0,"is_allow_empty_code":true},{"id":11,"title":"Certificate valid for 6 months from the date of sale for any goods without services","balance":100,"is_multi":false,"company_group_id":12,"item_type_id":2,"expiration_type_id":2,"expiration_timeout":6,"expiration_timeout_unit_id":3,"is_allow_empty_code":false}]
metaobject

Metadata (contains the number of certificate types found)

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

Get a List of Available Gift Card Types

Request

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

The list is an array of gift card types.

Gift card type has the following structure:

FieldTypeDescription
idnumberGift card type identifier
titlestringGift card type name
balancenumberGift card denomination
is_multibooleanWrite-off type: true - multiple write-off, false - single write-off
company_group_idnumberID of the chain where the gift card type is valid
item_type_idnumberApplication Constraint (list of possible values)
expiration_type_idnumberExpiration limit (list of possible values)
expiration_datestringFixed burn date in ISO8601 format (null if not set)
expiration_timeoutnumberGift card validity period from the date of sale (0 if not set)
expiration_timeout_unit_idnumberThe unit of measurement of the validity period of the gift card from the moment of sale (list of possible values, if not set - 0)
is_allow_empty_codebooleanAllow sale of gift card without code? true - allow, false - do not allow

Gift Card Type Restriction

MeaningDescription
0Unlimited
1Any services without products
2Any products without services
3Some services without products
4Some services and any products

Gift Card Type Expiration Limit

MeaningDescription
0No expiration date
1Fixed date for all instances
2Fixed period of validity from the date of sale

Units of certificate type validity period

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

location ID

Query
titlestring

Gift card 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
Content-Typestringrequired

application/json

Authorizationintegerrequired

Bearer partner_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/loyalty/certificate_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 'Content-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataArray of objects

Array of objects with data

Example: [{"id":1,"title":"Fixed burn date certificate without application restrictions","balance":10,"is_multi":true,"company_group_id":12,"item_type_id":0,"expiration_type_id":1,"expiration_date":"2026-09-21T23:00:00.000-05:00","expiration_timeout":0,"expiration_timeout_unit_id":0,"is_allow_empty_code":true},{"id":11,"title":"Certificate valid for 6 months from the date of sale for any goods without services","balance":100,"is_multi":false,"company_group_id":12,"item_type_id":2,"expiration_type_id":2,"expiration_timeout":6,"expiration_timeout_unit_id":3,"is_allow_empty_code":false}]
metaobject

Metadata (contains the number of certificate types found)

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

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