Skip to content
/
Get a list of locations

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

Get a list of locations

Request

Get a list of locations with data

Security
BearerPartner
Query
idnumber

Filter by location ID

Example: id=4564
group_idnumber

Filter by location chain ID Default: 83

Example: group_id=83
mynumber

For authorized user only. If you need locations that the user has rights to manage

Example: my=1
activenumber

If you need to get only locations with an active license and an available appointment

Example: active=1
moderatednumber

If you need to get only moderated locations, whose content is checked for publication

Example: moderated=1
forBookingnumber

Include date and time of the next free session in the location (ISO8601)

Example: forBooking=1
show_groupsnumber

Include in the location object a list of chains that this location belongs to

Example: show_groups=1
city_idnumber

Filter by city ID (cities getting method)

Example: city_id=2
showBookformsnumber

Include in the location object a list of location online booking forms

Example: showBookforms=1
min_idnumber

Filter by minimum location ID

Example: min_id=1000
show_deletednumber

Include deleted locations

Example: show_deleted=1
hide_record_type_singlenumber

Hide locations with individual appointment

Example: hide_record_type_single=1
hide_record_type_activitynumber

Hide locations with group appointment

Example: hide_record_type_activity=1
hide_record_type_mixednumber

Hide locations with mixed appointment

Example: hide_record_type_mixed=1
business_group_idnumber

Filter by business group ID

Example: business_group_id=1
business_type_idnumber

Filter by business type ID

Example: business_type_id=1
includeArray of strings

Include additional data in the location object

Items Enum"staff""positions""accounts""storages""expenses"
Example: include=staff&include=positions
countnumber

Number of locations per page

pagenumber

Page number

Headers
Acceptstringrequired

Must be application/vnd.api.v2+json

Content-Typestringrequired

Must be application/json

Authorizationstringrequired

Bearer partner_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/companies?id=4564&group_id=83&my=1&active=1&moderated=1&forBooking=1&show_groups=1&city_id=2&showBookforms=1&min_id=1000&show_deleted=1&hide_record_type_single=1&hide_record_type_activity=1&hide_record_type_mixed=1&business_group_id=1&business_type_id=1&include=staff%2Cpositions&count=0&page=0' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Success status (true)

Example: true
dataArray of objects

Array of objects

Example: [{"id":1050,"title":"La Visage","public_title":"La Visage Beauty","short_descr":"Beauty saloon","logo":"https://app.alteg.io/images/no-master.png","active":1,"phone":"+13155550175","phones":["+13155550175"],"email":"info@lavisage.com","country_id":7,"schedule":"","country":"United States","city_id":181,"city":"New York","timezone":-5,"timezone_name":"America/New_York","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"phone_confirmation":true,"active_staff_count":2,"next_slot":"2026-03-23T10:10:00-05:00","app_ios":"","app_android":"","currency_short_title":"$","reminds_sms_disabled":false,"reminds_sms_default":1,"group_priority":900,"bookform_group_priority":0,"description":"<p>Welcome to La Visage</p>","photos":[],"booking_widget_promo":null}]
metaArray of objects

Metadata (empty array)

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

Create a location

Request

Create new location

Security
BearerPartnerUser
Headers
Acceptstringrequired

Must be application/vnd.api.v2+json

Content-Typestringrequired

Must be application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Bodyapplication/jsonrequired
titlestring

location name

Example: "James Smith LLC"
country_idnumber

ID of the country in which the location is located (method to get a list of countries)

Example: 7
city_idnumber

Identifier of the city in which the location is located (method to get a list of cities)

Example: 2
addressstring

location address

Example: "New York, 787 Jackson Drive"
sitestring

location website

Example: "james-smith-company.com"
coordinate_latnumber(float)

Latitude

Example: 40.73061
coordinate_lotnumber(float)

Longitude

Example: -73.935242
business_type_idnumber

Business type

Example: 1
short_descrstring

location category

Example: "Beauty studio"
curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/companies \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "James Smith LLC",
    "country_id": 7,
    "city_id": 2,
    "address": "New York, 787 Jackson Drive",
    "site": "james-smith-company.com",
    "coordinate_lat": 40.73061,
    "coordinate_lot": -73.935242,
    "business_type_id": 1,
    "short_descr": "Beauty studio"
  }'

Responses

Created

Bodyapplication/json
successboolean

Success status (true)

Example: true
dataobject

data object

Example: {"id":1050,"title":"James Smith LLC","short_descr":"Beauty studio","logo":"https://app.alteg.io/images/no-master.png","active":1,"phone":"+13155550175","country_id":7,"schedule":"","country":"United States","city_id":181,"city":"New York","timezone_name":"America/New_York","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"phone_confirmation":true,"active_staff_count":2,"app_ios":"","app_android":"","currency_short_title":"R"}
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": {
    "id": 1050,
    "title": "James Smith LLC",
    "short_descr": "Beauty studio",
    "logo": "https://app.alteg.io/images/no-master.png",
    "active": 1,
    "phone": "+13155550175",
    "country_id": 7,
    "schedule": "",
    "country": "United States",
    "city_id": 181,
    "city": "New York",
    "timezone_name": "America/New_York",
    "address": "New York, 787 Jackson Drive",
    "coordinate_lat": 40.73061,
    "coordinate_lon": -73.935242,
    "phone_confirmation": true,
    "active_staff_count": 2,
    "app_ios": "",
    "app_android": "",
    "currency_short_title": "R"
  },
  "meta": []
}

Get location

Request

Getting information about the location.

Security
BearerPartner
Path
location_idnumberrequired

The ID of the location to get information about.

Example: 37532
Query
mynumber

For authorized user only. If you need additional data for the location that the user has rights to manage

Example: my=1
forBookingnumber

Date and time of the next free session in the location (ISO8601).

Example: forBooking=1
show_groupsnumber

Include in the location object a list of chains that this location belongs to

Example: show_groups=1
showBookformsnumber

Show location online booking forms (widgets)

Example: showBookforms=1
bookform_idnumber

Show url of online booking form with specified ID

Example: bookform_id=19203
Headers
Acceptstringrequired

Must be application/vnd.api.v2+json

Content-Typestringrequired

Must be application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/37532?my=1&forBooking=1&show_groups=1&showBookforms=1&bookform_id=19203' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Success status (true)

Example: true
dataobject

Object with data

Example: {"id":37532,"title":"James Smith LLC","country_id":7,"country":"United States","city_id":181,"city":"New York","timezone_name":"America/New_York","address":"New York, 787 Jackson Drive","zip":"11435","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"short_descr":"Beauty studio","social":{"facebook":"","instagram":"instagram.com/james_smith_company/","telegram":"","whatsapp":"","viber":""},"site":"james-smith-company.com","business_type_id":1,"description":"The <strong>James Smith</strong> location","phone_confirmation":true,"active_staff_count":2,"next_slot":"2026-03-23T10:10:00-05:00","group_priority":900,"push_notification_phone_confirm":1,"main_group_id":9206,"main_group":{"id":9206,"title":"James Smith LLC main location chain"},"groups":{"9206":{"id":9206,"title":"James Smith LLC main location chain"},"9207":{"id":9207,"title":"James Smith LLC extra location chain"}},"bookforms":[{"id":19203,"title":"James Smith LLC location appointment form","is_default":0,"url":"https://n19203.alteg.io/"}],"online_sales_form_url":"https://o1.alteg.io","access":{}}
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": {
    "id": 37532,
    "title": "James Smith LLC",
    "country_id": 7,
    "country": "United States",
    "city_id": 181,
    "city": "New York",
    "timezone_name": "America/New_York",
    "address": "New York, 787 Jackson Drive",
    "zip": "11435",
    "coordinate_lat": 40.73061,
    "coordinate_lon": -73.935242,
    "short_descr": "Beauty studio",
    "social": { … },
    "site": "james-smith-company.com",
    "business_type_id": 1,
    "description": "The <strong>James Smith</strong> location",
    "phone_confirmation": true,
    "active_staff_count": 2,
    "next_slot": "2026-03-23T10:10:00-05:00",
    "group_priority": 900,
    "push_notification_phone_confirm": 1,
    "main_group_id": 9206,
    "main_group": { … },
    "groups": { … },
    "bookforms": [ … ],
    "online_sales_form_url": "https://o1.alteg.io",
    "access": {}
  },
  "meta": []
}

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

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