Altegio
API docs by Redocly

Altegio REST API (1.0.1)

Download OpenAPI specification:

License: Apache 2.0 Terms of Service

This is an official document describing the interaction with the Altegio business managment platform. API allows third-party developers to perform most operations with the Altegio data. When designing methods, we tried to adhere to the REST architecture.

  • All interaction with protocol are transpire by TLS encryption (from 1.2 version)
  • Limits are 200 requests per minute or 5 requests per second per IP address
  • URL API: https://api.alteg.io/api/v1 If you encounter difficulties when working with the API, please carefully review the documentation, including the required headers, parameters, and the structure of the request body in the JSON example.

If you're having trouble resolving the issue on your own, feel free to contact us at api@alteg.io. Please include the request URL, headers, request body, and the response you received in your message.

Integration cases with Altegio

  • Data exchange with automation, accounting or CRM software
  • Integration of Online Booking into third-party websites and mobile applications. Allows embedding of Online Booking forms into external platforms, such as company catalogs, branded apps, and other partner services.
  • Data collection and analysis for business intelligence systems / Development of custom reporting and analytics tools
  • Chat bots and virtual assistants for appointment scheduling and client management

General description of data exchange with Altegio

The Altegio integration API includes two groups of methods:

  • Methods that require both user authorization and partner authorization
  • Methods that require partner authorization only (no user authorization)

API Request Authorization

Accessing both the first and second groups of methods requires partner authorization. I.e. passing the partner's unique hash key. API requests are authorized in accordance with RFC 6749 "Resource Owner Password Credentials Grant". When making API requests the HTTP authorization header must include the access key in the following format:

Authorization: Bearer <partner token>

To obtain this key, you need to register in the marketplace – it will be located in the 'Developer account' "Account settings" under "Account details" tab.

To get the user API key, use the auth method, or, if you are creating an integration application, use the key located in an application's settings under the "API Access" section. The key itself must also be sent in the request header (after the partner key, separated by a comma):

Authorization: Bearer <partner token>, User <user token>

Whether user authorization is required to work with specific entities is indicated in the data format descriptions and sample queries. Please note that not all users have access to all methods and data, depending on their assigned access rights.

Date and time

The most of dates in the API are represented as strings in ISO 8601 format. Exluding cases specified otherwise in outdated or deprecated methods.

"2025-09-21T23:00:00.000+03:00"

Service durations and other time-related values are provided in seconds. For example, a 15-minute service should be represented as:

{ "length": 900 }

Core Entities of the Altegio API

The API allows to work with most of the platform’s entities. However, please note that there are inconsistencies in the technical terminology: method and variable names, as well as terminology, may differ between the user interface and the documentation

Locations

A Location is an individual business unit that operates within the platform. Each Location belongs to a Chain. For single-location businesses, the platform still creates a single-location Chain. aka: company, branch, filial, salon

Users

A User is an account that provides authenticated access to one or more Locations. Access scope is defined by Roles, which are predefined sets of Access Rights. If a User does not have access to a module or method, the API returns HTTP 403. Each User is linked to one Team Member within a Location and may be linked to different Team Members across multiple Locations. Operational context (available Services, Schedule, permissions) depends on the current Location and Team Member binding. Most API methods require the User to be authorised (a valid token obtained) and to have explicit access to the target Location.

Team members and Positions

A Team Member is an individual within a Location who participates in operational processes: provides Services within Appointments, creates or manages reservations, or works with financial and analytical data (for example, a professional, cashier, administrator, or accountant). Team Members do not directly define access rights in the API, but they determine the business role and workload of a person inside a Location. Positions are logical groups of Team Members (similar to folders) that help structure staff by departments, functions, or specialisation. In some configurations, Positions are used to filter available reports. aka: employee, staff, staff_member, master

Schedule & Time Slots

A Schedule is a set of time intervals during which a Team Member or Resource is available to provide Services. A Time Slot is a specific available interval within the Schedule that can be booked online for an Appointment with a Team Member.

Appointments & Visits

An Appointment is a scheduled time interval during which a specific Team Member provides one or more Services or sells Products to a specific Client. A Visit is a group of one or more Appointments that take place during a single Client presence at a Location. Grouping rules depend on the Location settings. aka: record, booking

Clients

A Client is an individual who books, receives, or has received Services or Products from a Location. Client data is used for scheduling, communication, and analytics.

Services and Service Categories

A Service is a predefined type of work or procedure that can be provided to a Client by a Team Member within a Location. Each Service has key parameters such as duration, price (or price range), and applicable resources. Service Categories are logical groups used to organise Services for configuration, reporting, and client-facing catalogs.

Products and Product Categories

A Product is a tangible or consumable item that can be sold to a Client or used as part of a Service. Product Categories are logical groups used to organise Products for inventory management, reporting, and sales operations. aka: goods, items

Authentication B2C

End-customer authentication methods. Get access tokens required for some API operations.

Send SMS verification code for phone number

  • Request body
    • phone (required, string, '79991234567') - phone to which the code will be sent
    • fullname (option, sring, James) - Client name
Authorizations:
bearer
path Parameters
location_id
required
number
Example: 4564

location ID

header Parameters
Accept
required
string

application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
required
phone
string

Customer phone number

fulname
string

Client name

Responses

Request samples

Content type
application/json
{
  • "phone": "+1-315-555-0175",
  • "fulname": "James Smith"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}

Authorize Online Booking User

When a user of an online account changes their password, their API key will change and a new authorization will be required

Attribute Type Description
login string The visitor's phone number in the format 380000000000, or their email address.
password string Visitor password
Authorizations:
bearer
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
required
login
required
string

Phone number or Email

password
required
string

Password

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Log in with phone number and code

To access both online and offline (e.g., phone-made) appointments, the user must log in by verifying their phone number. This is done by requesting a confirmation code to be sent via SMS using the "SMS phone number verification code" endpoint.

Authorizations:
bearer
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
required
login
required
string

Phone number or Email

password
required
string

Password

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "user_token": "wec23fh8cDfFV4432fc352456"
}

Online Booking

Public online booking APIs and widgets. Allow clients to book appointments through external platforms.

Get dates available for booking

The dates available for booking object has the following fields:

Field Type Description
working_days array of working days grouped by month Working days of a team member/organization
working_dates array of dates An array of dates when the team member/organization works
booking_days array of days when there are free sessions Array of days that are available for booking for the specified services
booking_dates array of dates An array of dates when there are free sessions for the service to the selected team member/organization

working days and booking_days have the same format: month:[array of days in this month]

For example, this booking_days: "9": [ "4", "5"] "10": [ "14", "25"] Means that on September 4 and 5, and on October 14 and 25 there are free sessions for booking

The following filters are available:

  • service_ids: Array of service IDs. If you need dates when you can book the specified services
  • staff_id: team member ID. If you need dates when you can book the specified team member
  • date: Date within a month, if you need dates for a specific month
Authorizations:
bearer
path Parameters
location_id
required
number

location ID

query Parameters
service_ids[]
string

Service ID. Filter by the list of service identifiers

staff_id
number

team member ID. Filter by team member ID Default: 0

date
string
Example: date=2015-09-01

date in iso8601 format. Filter by month of booking.

date_from
string
Example: date_from=2015-09-01

date in iso8601 format. Start of dates to search. Must be used together with the "date_to" param and overrides the "date" param.

date_to
string
Example: date_to=2015-09-30

date in iso8601 format. End of dates to search. Must be used together with the "date_from" param and overrides the "date" param.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get Services Available for Booking

The object of services available for booking has the following fields:

Field Type Description
categories array of objects Array of service categories (you can't book a category)
services array of objects Services available for booking by category

An object from the categories array, has the following fields:

Field Type Description
id number Category ID
title string Category name
sex number Category belonging to gender (1 - male, 2 - female, 0 - not specified)
weight number Category weight. Categories are sorted by weight, heavier ones first
api_id string External Category ID

An object from the services array, has the following fields:

Field Type Description
id number Service ID
title string Service name
category_id number Identifier of the category to which the service belongs
weight number Category weight. Services are sorted by weight, heavier ones first
price_min number The minimum cost of the service
price_max number Maximum cost of the service
discount number Service discount
comment string Comment on the service
active number Is the service active
prepaid string Online payment status
sex number Gender for which the service is provided
session_length number Service duration in seconds (only if filter by team member is set)
image string Image services

If you need to get the services provided by a specific team member, then you need to use the filter by team member. The following filters are available:

  • staff_id: team member ID. If you need services that only the selected team member provides
  • datetime: date (in iso8601 format). Specifies the desired appointment date. Use this parameter to retrieve services that can be booked with the selected team member on that specific date.
  • service_ids: An array of service IDs. If a team member is already selected and the time and service(s) are part of an existing appointment, this parameter should be used to select an additional service.
Authorizations:
bearer
path Parameters
location_id
required
number
Example: 4564

location ID

query Parameters
staff_id
number

team member ID. Filter by team member ID Default: 0

datetime
string
Example: datetime=2025-09-09T18:30

date (in iso8601 format). Filter by service booking date (for example '2005-09-09T18:30') Default: ''

service_ids[]
Array of numbers

Service ID. Filter by the list of identifiers of already selected (within one appointment) services. It makes sense if a filter by team member and date is set.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get team members available for booking

Each object from the array of team members available for booking has the following fields:

Field Type Description
id number team member ID
name string team member name
specialization string team member specialization
position object team member position
bookable boolean Does the team member have sessions available for booking
weight number team member weight. When withdrawing, team members are sorted by weight, heavier first
show_rating number Whether to show team member's rating (1 - show, 0 - don't show)
rating number team member rating
votes_count number Number of votes rated team member
comments_count number Number of comments to a team member
avatar string Path to team member avatar file
information string Additional information about the team member (HTML format)
session_date string Date of the next day that there are available sessions (only for bookable = true)

The following filters are available:

  • service_ids: Array of service IDs. If you need team members who provide only the selected service
  • datetime: date (in iso8601 format). If you need team members who have sessions for the specified service at the specified time
Authorizations:
bearer
path Parameters
location_id
required
number
Example: 4564

location ID

query Parameters
service_ids[]
Array of numbers

Service ID. Filter by the list of service identifiers

datetime
number

date in iso8601 format. Filter by service booking date (for example '2005-09-09T18:30')

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}

Get the nearest available time slots

the team member's nearest sessions object has the following fields:

Field Type Description
session_date string Next date with available sessions
sessions array List of available sessions

The following filters are available:

  • service_ids: Array of service IDs. If you need sessions, when can you book these services
  • datetime: date (in iso8601 format) for which you want to get the next sessions
Authorizations:
bearer
path Parameters
location_id
required
number

location ID

team_member_id
required
number

team member ID

query Parameters
service_ids[]
Array of numbers

Service ID. Filter by the list of service identifiers

datetime
number

date in iso8601 format. Filter by date

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get a List of Sessions Available for Booking

The sessions available for booking object has the following fields:

Field Type Description
time string Session time (17:30 for example)
session_length number Session duration in seconds
datetime datetime Date and time of the session in ISO8601 format (must be passed when creating the appointment)

The following filters are available:

  • service_ids: Array of service IDs. If you need sessions, when can you book these services
Authorizations:
bearer
path Parameters
location_id
required
number

location ID

date
required
string

date in iso8601 format. Filter by booking date (eg '2015-09-30')

team_member_id
required
number

team member ID. Filter by team member ID Default: 0

query Parameters
service_ids[]
string

Service ID. Filter by the list of service identifiers

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}

Validate Booking Params

After generating the appointment parameters, you can validate them to ensure the appointment can be successfully created.

The JSON object containing the Online Booking parameters includes the following fields:

Field Type Mandatory Description
appointments Array of objects YES Booking options (services, team members...)

The appointments array consists of objects that have the following fields:

Field Type Mandatory Description
id number Yes Booking ID for post-save feedback (see response to request).
services array of numbers NO Array of IDs of the services the client wants to sign up for
staff_id number YES ID of the team member the client wants to book with (0 if any team member is selected)
datetime datetime YES Session date and time in ISO8601 format (passed for each session in the book_times resource)

In response to the parameter check request, an empty response with the code 201 will be returned if the booking parameters are in order and bookings can be created:

If the response is JSON with an HTTP code other than 201, then the booking parameters are out of order, and bookings cannot be created.

The server may return the following errors during appointment creation:

  1. Selected time slot is already taken. Returned with HTTP status code 422 and error code 433.

  2. No team members available for booking. Occurs if a default team member was selected but none are available. Returned with HTTP status code 422 and error code 436.

  3. Booking time conflict within the same request. One of the selected booking times overlaps with another booking created in the same request. Returned with HTTP status code 422 and error code 437, including the conflicting booking’s id in the appointments array.

  4. Service not available for booking The selected service is no longer available (e.g. removed by the location). Returned with HTTP status code 422 and error code 438.

Authorizations:
bearer
path Parameters
location_id
required
number

location ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
required
appointments
required
Array of objects

appointment options (services, team members...)

Responses

Request samples

Content type
application/json
{
  • "appointments": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}

Create a Session Appointment

To create a session appointment, provide a JSON object containing the online booking parameters. The object includes the following fields:

Field Type Mandatory Description
phone string YES Client's phone number (eg 79161502239)
full name string YES Client name
email string NO Postal address of the client
appointments Array of objects YES Booking options (services, team members...)
code string NO Phone number confirmation code sent via SMS (only needed if you need to confirm the number)
notify_by_sms number NO Number of hours in advance to send an SMS reminder for the appointment (set to 0 to disable reminders).
notify_by_email number NO Number of hours in advance to send an email reminder for the appointment (set to 0 to disable the reminder).
comment string NO Appointment Comment
api_id string NO External Appointment ID

The appointments array consists of objects that have the following fields:

Field Type Mandatory Description
id number Yes Booking ID for post-save feedback (see response to request).
services array of numbers NO Array of IDs of the services the client wants to sign up for
staff_id number YES ID of the team member the client wants to book with (0 if any team member is selected)
datetime datetime YES Session date and time in ISO8601 format (passed for each session in the book_times resource)
custom_fields key-value object NO Additional field values that are returned with the appointment

Additional fields in the appointments array

When additional appointment fields are created (see the "Additional Fields" section), you can pass custom values for them during appointment creation. These fields are unique to each location. Once the additional fields are set up, their values can be included in the optional custom_fields parameter. This should be passed as a key–value object, where each key corresponds to the code of the additional field. Example:

  • location created an additional appointment field with code="my_custom_field" type="number", and a second field code="some_another_field" type="list"
  • When creating an appointment, another attribute was passed in the appointments array element: "" appointments: [{ ... }, { ... custom_fields: { "my_custom_field": 123, "some_another_field": ["first value", "second value"] } }]"
  • When this appointment is received by the GET method later, the same value of additional fields will be returned in the response

In response to the request to create an appointment, an array of objects will come (the number of objects is equal to the number of objects in the appointments array) with the following fields:

Field Type Description
id number The appointment ID as passed in the original appointments array
record_id number The unique identifier of the appointment created in the system
record_hash string A temporary ID used for deleting the appointment immediately after creation

Errors to be handled:

  1. Incorrect SMS verification code. Returned with HTTP status 422 and error code 432. The SMS verification code entered by the user is invalid.

  2. Selected time slot is already taken. Returned with HTTP status 422 and error code 433. The selected appointment time is unavailable. The response includes the id of the conflicting appointment from the appointments array.

  3. User is blacklisted. Returned with HTTP status 403 and error code 434. The user with the specified phone number is blacklisted and cannot book an appointment.

  4. Invalid phone number format. Returned with HTTP status 422 and error code 431. The user's phone number is not in a valid format.

  5. Missing client name. Returned with HTTP status 422 and error code 435. The client's name was not provided.

  6. No available team members. Returned with HTTP status 422 and error code 436. No team members are available at the selected time (commonly occurs when using a default team member setting).

  7. Overlapping appointments in request. Returned with HTTP status 422 and error code 437. One of the selected times overlaps with another appointment in the same request. The response includes the id of the conflicting appointment from the appointments array.

Authorizations:
bearer
path Parameters
location_id
required
number

location ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
required
phone
required
string

Customer phone

fullname
required
string

Client name

email
string

Postal address of the client

code
number

SMS confirmation code for verifying the phone number. This field is required if the location has phone_confirmation = true

comment
string

Commentary on the post

type
string

Appointment source

notify_by_sms
number

Specifies how many hours before the visit an SMS reminder should be sent to the client. Set to 0 if no reminder is needed.

notify_by_email
number

Specifies how many hours before the visit an email reminder should be sent to the client. Set to 0 if no reminder is needed.

api_id
number

Appointment ID from external system

Array of objects

Appointment options (session, services, team member)

Responses

Request samples

Content type
application/json
{
  • "phone": "+1-315-555-0175",
  • "fullname": "James Smith",
  • "email": "[email protected]",
  • "code": 38829,
  • "comment": "test appointment!",
  • "type": "mobile",
  • "notify_by_sms": 6,
  • "notify_by_email": 24,
  • "api_id": 777,
  • "appointments": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}

Move Appointment to Session

Authorizations:
bearer
path Parameters
location_id
required
number

location ID

record_id
required
number

ID of the appointment to be migrated

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
required
datetime
string <date-time>

Date and time to which we want to move the appointment

comment
string

Appointment Comment

Responses

Request samples

Content type
application/json
{
  • "datetime": "2025-09-21T23:00:00.000+03:00",
  • "comment": "DODO!"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get an appointment for a session

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

record_id
required
number
Example: 22123

Post ID (enough to view the post if the user is logged in)

record_hash
required
string
Example: 'dawd4fs09rhf0s9fafef0'

HASH appointments (required to view the appointment if the user is not authorized)

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "id": 13132699,
  • "services": [
    ],
  • "company": {
    },
  • "staff": {
    },
  • "clients_count": 1,
  • "date": "2025-09-21T23:00:00.000+03:00",
  • "datetime": "2017-10-24T17:30:00+0000",
  • "create_date": "2017-10-20T21:40:24+0000",
  • "comment": "",
  • "deleted": true,
  • "attendance": 0,
  • "length": 1800,
  • "notify_by_sms": 0,
  • "notify_by_email": 0,
  • "master_requested": false,
  • "online": true,
  • "api_id": "",
  • "last_change_date": "2017-10-24T23:54:02+0000",
  • "prepaid": false,
  • "prepaid_confirmed": false,
  • "activity_id": 0
}

Create an Appointment in a Group Event

Authorizations:
bearer
path Parameters
location_id
required
number

location ID

activity_id
required
integer

Group Event ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Request Body schema: */*
required
fullname
required
string

Client name

phone
required
string

Customer phone (for example 79161502239)

email
string

Postal address of the client

code
number

SMS confirmation code for verifying the phone number. This field is required if the location has phone_confirmation = true

comment
string

Appointment Comment

notify_by_sms
integer <int32>

Specifies how many hours in advance an SMS reminder should be sent before the appointment. Set to 0 to disable SMS reminders.

notify_by_email
integer <int32>

Specifies how many hours in advance an email reminder should be sent before the appointment. Set to 0 to disable email reminders

type
string

Appointment source

api_id
number

Appointment ID from external system

clients_count
number

number of seats

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get configurations of the booking form

Each Altegio client can create an unlimited number of Online Booking forms with different designs and booking scenarios.

Typically, the ID of a booking form is embedded in the subdomain. For example: https://b123.alteg.io, where 123 is the booking form ID. This ID can be used to retrieve all necessary parameters for implementing Online Booking and to determine whether the booking applies to a specific company or a company chain.

For chain widgets, you will also need to call the [GET] /locations method with the company_id filter to retrieve the list of locations available for booking.

The object containing the Online Booking form settings includes the following fields:

Field Type Description
steps Array of objects Booking form steps with custom settings
style object Booking form design settings
group_id number Company chain ID (0 - if the booking form is for a non-chain company)
company_id number Company ID (always returned, used to get additional settings)
phone_confirmation boolean Do I need to confirm the phone by SMS (if groupid = 0 (not a group form), otherwise look in the settings of each company separately)
language string Booking form language (code from langs array)
langs array of object List of widget languages
comment_required boolean Whether the field with a comment within booking is required
google_analytics_id string Google Analytics ID
facebook_pixel_id string Facebook Pixel ID
sms_enabled boolean Is sending SMS available?
comment_input_name string (optional) Title for the field with a comment to the booking (if not set, the default value is used)
booking_notify_text string (optional) The text of the notification that is displayed (if set) at the step of entering contact data
is_show_privacy_policy boolean Whether it is necessary to display the text of the agreement on the personal data processing policy to the user
specialization_display_mode number Display the specialization or position of the team member. 0 - Specialization, 1 - Position

The steps array consists of objects that have the following fields:

Field Type Description For what steps is specified
step string Step city/company/service/team member/datetime/contact/confirm
title string Name of the step to display in the interface For everyone
number number What number should this step be displayed on (starting from 1) For everyone
default string or number The default value for this step, if set For all but datetime
hidden boolean Hide this step when booking or not For everyone
date_hidden boolean Hide this step when booking or not For datetime
time_hidden boolean Hide this step when booking or not For datetime
date_default string The default value for this step, if set For datetime
time_default number The default value for this step, if set For datetime

The style object has the following fields:

Field Type Description
show header boolean Show header and menu or not
logo string Path to logo image
header_background string Path to subtitle background image
menu_background string Path to menu background image
primaryPalette string The main color of the form (all colors from the list: red, pink, purple, deep-purple, indigo, blue, light-blue, cyan, teal, green, light-green, lime, yellow, amber, orange, deep-orange, brown , grey, blue-grey, white, black)
accentPalette string Form secondary color (subtitle semi-transparent cover)
warnPalette string Booking form buttons color
backgroundPalette string Booking form background color
Authorizations:
bearer
path Parameters
id
required
number
Example: 1

ID of thebooking form

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get internationalization options

Translation is available in one of the languages:

  • Latvian - 'lv-LV'
  • English - 'en-US'
  • Estonian - 'ee-EE'
  • Lithuanian - 'lt-LT'
  • German - 'de-DE'
  • Ukrainian - 'uk-UK'
Authorizations:
bearer
path Parameters
lang_code
required
string
Example: en-US

Language code. One of the set 'lv-LV', 'en-US', 'ee-EE', 'lt-LT', 'de-DE', 'uk-UK'

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response samples

Content type
application/json
{
  • "404": {
    },
  • "action": {
    },
  • "tips": {
    },
  • "payment-status": {
    },
  • "user-data-form": {
    },
  • "and": "and",
  • "terms-of-agreement": "Terms of agreement",
  • "data-processing": "Data processing",
  • "license-agreement": "License agreement",
  • "personal-data": "Your data",
  • "buy-for": "Buy for",
  • "group_booking": {
    },
  • "geo": {
    },
  • "tooltips": {
    },
  • "prepaid": {
    },
  • "back": "Back",
  • "backCity": "Cities",
  • "backFilials": "Locations",
  • "backRecordType": "Record Type",
  • "filials": "Locations",
  • "my_profile": "Cabinet",
  • "about_us": "About Us",
  • "record": {
    },
  • "at": "v",
  • "on": "on the",
  • "h": "h.",
  • "m": "min.",
  • "from": "from",
  • "dist_m": "m",
  • "dist_km": "km",
  • "yesterday": "yesterday",
  • "today": "today",
  • "tomorrow": "tomorrow",
  • "Close": "close",
  • "Yes": "Yes",
  • "No": "Not",
  • "refresh": "Refresh",
  • "online_record_disabled": "Online registration is disabled. <br> We apologize for the inconvenience caused.",
  • "online_record_disabled_long_text": "Online registration is temporarily unavailable. You can still manage your online records in your account, transfer them and delete them.",
  • "address": {
    },
  • "common": {
    },
  • "notification": {
    },
  • "header": {
    },
  • "loyalty": {
    },
  • "save": "Save",
  • "proceed": "Continue",
  • "profile": {
    },
  • "registration": {
    },
  • "menu": {
    },
  • "footer": {
    },
  • "city": {
    },
  • "company": {
    },
  • "steps": {
    },
  • "master": {
    },
  • "cart": {
    },
  • "reviews": {
    },
  • "date": {
    },
  • "time": {
    },
  • "service": {
    },
  • "confirm": {
    },
  • "login": {
    },
  • "Jan": "January",
  • "Feb": "February",
  • "March": "Martha",
  • "Mar": "Martha",
  • "Apr": "April",
  • "May": "May",
  • "Jun": "June",
  • "Jul": "July",
  • "Aug": "august",
  • "Sep": "September",
  • "Oct": "October",
  • "Nov": "november",
  • "Dec": "December",
  • "activity": {
    },
  • "button": {
    },
  • "landscape": "It will be more convenient if you turn the device vertically"
}

Appointments & User Account

End-customer account. Manage user profile, appointments, and other operations.

Updating User Data in Online Booking

Updating a team member’s data in online booking.

When updating a phone number, the confirmation_code field must be included in the request. This code should be obtained using the SMS confirmation code of the phone number to change data

Authorizations:
(beareruser)
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
required
name
string

Name

email
string

mail

phone
string

Phone number

confirmation_code
string

SMS confirmation code (when changing phone number)

Responses

Request samples

Content type
application/json
{
  • "name": "James Smith",
  • "email": "[email protected]",
  • "phone": "+1-315-555-0175",
  • "confirmation_code": "1234"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}

Retrieving Online Booking User Data

Retrieve online booking user data.

Authorizations:
(beareruser)
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{}

Online Booking User Password Update

Updating the password of an online booking user.

The response comes with a new user token.

Authorizations:
(beareruser)
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
required
old_password
string

Current Password

new_password
string

New password

Responses

Request samples

Content type
application/json
{
  • "old_password": "qwerty123",
  • "new_password": "example!"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Send SMS verification code for phone number to change data

The request must contain one of two parameters: company_id or group_id

Authorizations:
(beareruser)
query Parameters
company_id
required
integer

location ID

group_id
required
integer

Chain ID

phone
required
string

Phone number

header Parameters
Accept
required
string

application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}

Get User Appointments

The JSON Object containing the user appointment parameters has the following fields:

Field Type Mandatory Description
id number YES Appointment ID
services array of numbers YES List of ID service appointments
location object YES location parameters
staff object YES Parameters of the team member who was booked
clients_count int YES Number of clients
date string YES Session date
datetime string YES Session date in ISO
create_date string YES Appointment creation date
length number YES Session duration
deleted boolean YES Has the appointment been created ? (true if deleted)
notify_by_sms number NO Number of hours in advance to send an SMS reminder for the appointment. Set to 0 to disable SMS reminders
notify_by_email number NO Number of hours in advance to send an email reminder for the appointment. Set to 0 to disable email reminders
comment string YES Appointment Comment
master_requested boolean YES Whether a specific team member was specified when appointment (false if "any team member" was specified)
online boolean YES Indicates whether the appointment was created online by the client (true) or manually by an administrator (false)
visit_attendance number YES 2 - The user confirmed the appointment, 1 - The user came, the services were provided, 0 - the user was waiting, -1 - the user did not come to visit
api_id string NO External Appointment ID
last_change_date string NO Date of the last edit of the appointment
prepaid boolean NO Is online payment available for appointment
prepaid_confirmed boolean NO Online payment status
last_change_date string NO Date of the last edit of the appointment
activity_id int NO ID bringing group event

Each object in the services array has the following fields:

Field Type Description
id number Service ID
title string Service name
cost float Service cost
price_min float Minimum price of the service
price_max float Maximum service price
discount float Discount
amount int Number of ordered services
session_length int Service duration in seconds (only if filter by team member is set)

The location object has the following fields:

Field Type Description
id number location ID
title string location name
country_id number Identifier of the country in which the location is located
country string location name
city_id number Identifier of the city where the location is located)
city string location city name
time zone string timezone locations
address string Address where the location is located
phone string location's main phone number
phones array of strings All phone numbers of the location
coordinate_lat float Latitude where the location is located
coordinate lng float Longitude
allow_delete_record boolean Is it possible to delete an appointment
allow_change_record boolean Is it possible to reschedule the appointment
site string location website
currency_short_title string Currency symbol
allow_change_record_delay_step int Time after which you can reschedule the appointment
allow_delete_record_delay_step int Time after which you can delete an appointment

The staff object has the following fields:

Field Type Description
id number team member ID
name string team member name
specialization string team member specialization
position object team member position
show_rating number Whether to show team member's rating (1 - show, 0 - don't show)
rating number team member rating
votes_count number Number of votes rated team member
comments_count number Number of comments to a team member
avatar string Path to team member avatar file
Authorizations:
(beareruser)
path Parameters
record_id
required
number
Example: 22123

Appointment ID

record_hash
required
string
Example: 'dawd4fs09rhf0s9fafef0'

HASH of the appointment

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}

Delete User Appointment

Authorizations:
(beareruser)
path Parameters
record_id
required
number
Example: 22123

Appointment ID (enough to delete the appointment if the user is authorized)

record_hash
required
string
Example: 'dawd4fs09rhf0s9fafef0'

HASH appointments (required to delete the record if the user is not authorized)

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}

Authentication B2B

SaaS users authentication methods. Get access tokens required for all API operations.

Authorize User

When a user changes their password, their API key is regenerated. As a result, reauthorization is required using the new API key.

Attribute Type Description
login string The user's phone number in the format 380000000000, or their email address.
password string User password
Authorizations:
bearer
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
required
login
required
string

Phone number or Email

password
required
string

Password

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Locations

Location (company) management. Create, read, update locations and their settings.

Get a list of locations

Get a list of locations with data

Authorizations:
bearer
query Parameters
id
number
Example: id=4564

Filter by location ID

group_id
number
Example: group_id=83

Filter by location chain ID Default: 83

my
number
Example: my=1

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

active
number
Example: active=1

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

moderated
number
Example: moderated=1

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

forBooking
number
Example: forBooking=1

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

show_groups
number
Example: show_groups=1

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

city_id
number
Example: city_id=2

Filter by city ID (cities getting method)

showBookforms
number
Example: showBookforms=1

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

min_id
number
Example: min_id=1000

Filter by minimum location ID

show_deleted
number
Example: show_deleted=1

Include deleted locations

hide_record_type_single
number
Example: hide_record_type_single=1

Hide locations with individual appointment

hide_record_type_activity
number
Example: hide_record_type_activity=1

Hide locations with group appointment

hide_record_type_mixed
number
Example: hide_record_type_mixed=1

Hide locations with mixed appointment

business_group_id
number
Example: business_group_id=1

Filter by business group ID

business_type_id
number
Example: business_type_id=1

Filter by business type ID

include
Array of strings
Items Enum: "staff" "positions" "accounts" "storages" "expenses"
Example: include=staff&include=positions

Include additional data in the location object

count
number

Number of locations per page

page
number

Page number

header Parameters
Accept
required
string

Must be application/vnd.api.v2+json

Content-Type
required
string

Must be application/json

Authorization
required
string

Bearer partner_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}

Create a location

Create new location

Authorizations:
(beareruser)
header Parameters
Accept
required
string

Must be application/vnd.api.v2+json

Content-Type
required
string

Must be application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
required
title
string

location name

country_id
number

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

city_id
number

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

address
string

location address

site
string

location website

coordinate_lat
number <float>

Latitude

coordinate_lot
number <float>

Longitude

business_type_id
number

Business type

short_descr
string

location category

Responses

Request samples

Content type
application/json
{
  • "title": "James Smith LLC",
  • "country_id": 1,
  • "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"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get location

Getting information about the location.

Authorizations:
(beareruser)
path Parameters
location_id
required
number
Example: 37532

The ID of the location to get information about.

query Parameters
my
number
Example: my=1

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

forBooking
number
Example: forBooking=1

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

show_groups
number
Example: show_groups=1

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

showBookforms
number
Example: showBookforms=1

Show location online booking forms (widgets)

bookform_id
number
Example: bookform_id=19203

Show url of online booking form with specified ID

header Parameters
Accept
required
string

Must be application/vnd.api.v2+json

Content-Type
required
string

Must be application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Change location

Change location data

Authorizations:
(beareruser)
path Parameters
location_id
required
number
Example: 37532

location ID

header Parameters
Accept
required
string

Must be application/vnd.api.v2+json

Content-Type
required
string

Must be application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
required
title
string

location name

country_id
number

Country ID (has higher priority then country)

country
string

Country

city_id
number

City ID (has higher priority then city)

city
string

City

address
string

location address

zip
string

Zip code

phones
Array of strings

location phone numbers

object

location social media

site
string

location website

coordinate_lat
number <float>

Latitude

coordinate_lon
number <float>

Longitude

description
string <html>

Description

business_type_id
number <int32>

Business type

short_descr
string

Business category

Responses

Request samples

Content type
application/json
{
  • "title": "James Smith LLC",
  • "country": "United States",
  • "city": "New York",
  • "address": "New York, 787 Jackson Drive",
  • "zip": "11435",
  • "phones": [
    ],
  • "social": {
    },
  • "site": "james-smith-company.com",
  • "coordinate_lat": 40.73061,
  • "coordinate_lon": -73.935242,
  • "description": "The <strong>James Smith</strong> location",
  • "business_type_id": 1,
  • "short_descr": "Beauty studio"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Delete location

Delete a location.

Authorizations:
(beareruser)
path Parameters
location_id
required
number
Example: 37532

location ID

header Parameters
Accept
required
string

Must be application/vnd.api.v2+json

Content-Type
required
string

Must be application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "errors": {
    },
  • "meta": {
    }
}

Services

Service and service category management. Define services offered by your locations.

Create a service category

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
required
title
string

Service category name

api_id
string

External Category ID

weight
number

Category weight (used to sort categories when displayed)

staff
Array of numbers

List of IDs of team members providing services from the category

Responses

Request samples

Content type
application/json
{
  • "title": "Haircut very feminine",
  • "api_id": "adw322",
  • "weight": 111,
  • "staff": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get a list of services

Returns a list of all services for the specified location

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

query Parameters
staff_id
number

Team member ID, if you want to filter by team member

category_id
number

Category ID, if you want to filter by category

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}

Create a service

Method to create a service

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorizarion
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
required
title
string

Service name

category_id
number

Service Category ID

price_min
number <float>

The minimum cost of the service

price_max
number <float>

Maximum cost of the service

duration
number <float>

Service duration, default is 3600 seconds

discount
number <float>

Service discount

comment
string

Comment on the service

weight
number

Service weight (used to sort services when displayed)

active
number

Is the service available for online booking? 1 - available, 0 not available.

api_id
string

External Service ID

Array of objects

team members who provide the service, along with the duration of the service for each team member

Responses

Request samples

Content type
application/json
{
  • "title": "Men's haircut",
  • "category_id": 83167,
  • "price_min": 1300,
  • "price_max": 1300,
  • "duration": 3600,
  • "discount": 0,
  • "comment": "",
  • "weight": 6,
  • "active": 1,
  • "api_id": "00000000042",
  • "staff": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Deprecated. Get a list of service categories Deprecated

Get a list of service categories

Authorizations:
bearer
path Parameters
location_id
required
number

location ID

id
required
number

Service category identifier

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}

Deprecated. Get a list of services / specific service Deprecated

Authorizations:
bearer
path Parameters
location_id
required
number

location ID

service_id
required
number

Service ID, if you need to work with a specific service.

query Parameters
staff_id
number

team member ID, if you want to filter by team member

category_id
number

Category ID, if you want to filter by category

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}

Deprecated. Change Service Deprecated

Deprecated. Method to change the service

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

service_id
required
number

Service ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
required
title
string

Service name

category_id
number

Service Category ID

price_min
number <float>

The minimum cost of the service

price_max
number <float>

Maximum cost of the service

duration
number <float>

Service duration, default is 3600 seconds

discount
number <float>

Service discount

comment
string

Comment on the service

weight
number

Service weight (used to sort services when displayed)

active
number

Is the service available for online booking? 1 - available, 0 not available.

api_id
string

External Service ID

Array of objects

team members who provide the service, along with the duration of the service for each team member

Responses

Request samples

Content type
application/json
{
  • "title": "Men's haircut",
  • "category_id": 83167,
  • "price_min": 1300,
  • "price_max": 1300,
  • "duration": 3600,
  • "discount": 0,
  • "comment": "",
  • "weight": 6,
  • "active": 1,
  • "api_id": "00000000042",
  • "staff": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Change service

Method to change the service

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

service_id
required
number

Service ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
required
title
required
string

Service name

booking_title
required
string

Service name for appointment

category_id
required
number

ID service category

price_min
required
number <float>

Minimum cost of the service

price_max
required
number <float>

Maximum cost of the service

duration
required
number

Service duration, default value is 3600

discount
number <float>

Service discount

comment
string

Comment on the service

is_multi
required
boolean

false - Appointment, true - Event

tax_variant
required
number

Bill ID

vat_id
required
number

VAT ID

is_need_limit_date
required
boolean

The service is available for a limited time

seance_search_start
required
number

Start of period is the appointment available, in seconds

seance_search_finish
required
number

End of period is the appointment available, in seconds

step
required
number

Display interval of slots, in seconds

seance_search_step
required
number

Search interval of slots, in seconds

weight
number

Service weight (used to sort services when displayed)

active
number

1 - available for online recording, 0 - not available

api_id
string

External Service ID

Array of objects

List of team members providing the service and session duration

Responses

Request samples

Content type
application/json
{
  • "title": "Men's haircut",
  • "booking_title": "Men's haircut",
  • "category_id": 83167,
  • "price_min": 1300,
  • "price_max": 1300,
  • "duration": 3600,
  • "discount": 0,
  • "tax_variant": 1,
  • "vat_id": 3,
  • "is_multi": false,
  • "is_need_limit_date": true,
  • "date_from": "2022-09-19",
  • "date_to": "2022-09-30",
  • "seance_search_start": 36000,
  • "seance_search_finish": 84600,
  • "step": 300,
  • "seance_search_step": 900,
  • "comment": "",
  • "weight": 6,
  • "active": 1,
  • "api_id": "00000000042",
  • "staff": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Delete a service

Method to remove a service

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

service_id
required
number

Service ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}

Get service category

Authorizations:
bearer
path Parameters
location_id
required
number

location ID

id
required
number

Service Category ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Change service category

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

id
required
number

Service Category ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
required
title
string

Service category name

api_id
string

External Category ID

weight
number

Category weight (used to sort categories when displayed)

staff
Array of numbers

List of IDs of team members providing services from the category

Responses

Request samples

Content type
application/json
{
  • "title": "Haircut very feminine",
  • "api_id": "adw322",
  • "weight": 111,
  • "staff": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Delete service category

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

id
required
number

Service Category ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Conetnt-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}

Get a list of service categories

  • Options
    • company_id (required, number) - company ID
    • id (optional, number) - service category ID (to work with a specific category)
    • staff_id (optional, number) - team member ID (to get categories associated with a team member)
Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

id
required
number

Service Category ID

query Parameters
staff_id
number

team member ID (to get categories associated with a team member)

header Parameters
Accept
required
string

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Get a list of services / specific service

  • Parameter
    • company_id (required, number, 1) - company ID
    • service_id (optional, number, 1) - service ID
Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

service_id
required
number

Service ID, if you need to work with a specific service.

query Parameters
staff_id
number

team member ID, if you want to filter by team member

category_id
number

Category ID, if you want to filter by category

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Linking a Team Member to a Provided Service

Creates an employee service link with provided duration and bill of materials.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

service_id
required
number
Example: 123

ID of service.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
master_id
required
number

ID of a team member who provides the service.

seance_length
required
number

Duration of service provision by the specified employee in seconds,
minimum 300 seconds (5 minutes), maximum 86100 seconds (23 hours 55 minutes).

technological_card_id
required
number or null

ID of bill of materials used while providing the service.

Responses

Request samples

Content type
application/json
{
  • "master_id": 123,
  • "seance_length": 3600,
  • "technological_card_id": 123
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Updating Team Member Service Link Settings

Updates an employee service link with provided duration and bill of materials.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

service_id
required
number
Example: 123

ID of service.

team_member_id
required
number
Example: 123

ID of staff.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
seance_length
required
number

Duration of service provision by the specified employee in seconds,
minimum 300 seconds (5 minutes), maximum 86100 seconds (23 hours 55 minutes).

technological_card_id
required
number or null

ID of bill of materials used while providing the service.

Responses

Request samples

Content type
application/json
{
  • "seance_length": 3600,
  • "technological_card_id": 123
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Deleting a Team Member Service Link

Deletes an employee service link.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

service_id
required
number
Example: 123

ID of service.

team_member_id
required
number
Example: 123

ID of staff.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}

Get a list of chain service categories

Authorizations:
(beareruser)
path Parameters
chain_id
required
integer

Chain ID

query Parameters
include
string
Value: "services"

Include additional resources in response

header Parameters
Accept
required
string

application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Team Members

Staff member management, including positions, service assignments, and team member profiles.

Deprecated. Add new team member Deprecated

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
required
name
string

team member name

specialization
string

team member specialization

weight
number

team member weight. team members are sorted by weight on exit, heavier first

information
string

team member information (HTML format)

api_id
string

External team member ID

hidden
number

Display status in online appointment, 1 - hidden, 0 - not hidden

fired
number

the team member's dismissal status, 1 - dismissed, 0 - not dismissed

user_id
number

Linked user ID, 0 - unlink user

Responses

Request samples

Content type
application/json
{
  • "name": "Basil",
  • "specialization": "the hairdresser",
  • "weight": 10,
  • "information": "Trimming with three hands",
  • "api_id": "42",
  • "hidden": 0,
  • "fired": 0,
  • "user_id": 123
}

Response samples

Content type
application/json
{}

Deprecated. Get a list of employees / specific employee Deprecated

Authorizations:
bearer
path Parameters
location_id
required
number

location ID

team_member_id
required
number

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

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response samples

Content type
application/json
{}

Edit Team Member

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

team_member_id
required
number

team member ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: */*
required
name
string

team member name

specialization
string

team member specialization

weight
number

team member weight. team members are sorted by weight on exit, heavier first

information
string

team member information (HTML format)

api_id
string

External team member ID

hidden
number

Display status in online appointment, 1 - hidden, 0 - not hidden

fired
number

the team member's dismissal status, 1 - dismissed, 0 - not dismissed

user_id
number

Linked user ID, 0 - unlink user

Responses

Response samples

Content type
application/json
{}

Delete team member

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

team_member_id
required
number

team member ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}

Quick create an employee

Creates a new employee with a minimal set of parameters.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
name
required
string

Name of a team member.

specialization
required
string

Specialization of a team member.

position_id
required
number or null

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

phone_number
required
string or null

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

user_email
required
string <email>

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

user_phone
required
string

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

is_user_invite
required
boolean

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

Responses

Request samples

Content type
application/json
{
  • "name": "John Johnson",
  • "specialization": "Cosmetologist",
  • "position_id": 123,
  • "phone_number": 11234567890,
  • "user_email": "[email protected]",
  • "user_phone": 11234567890,
  • "is_user_invite": false
}

Response samples

Content type
application/json
{}

Get Team Members / Specific Team Member

Authorizations:
(beareruser)
path Parameters
location_id
required
number

Location ID

team_member_id
required
number

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

header Parameters
Accept
required
string

application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{}

Get a list of company positions

The method allows you to get a list of current positions in the location

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": [
    ],
  • "success": true
}

Quick create a position

Creates a new position in a company; position is created as a chain entity and at the same time linked to a company initiated its creation.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
title
required
string

Title of a position.

Responses

Request samples

Content type
application/json
{
  • "title": "Position"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Get company users

The method allows you to get users of the location.
location User object:

Attribute Type Description
id number User ID
name string User name
phone string User phone
email string User email
information string User information
is_approved boolean Whether the user accepted the invitation to manage the location
is_non_deletable boolean Whether the user is non-deletable
Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

query Parameters
filter[is_approved]
number
Example: filter[is_approved]=1

Whether the user accepted the invitation to manage the location. 1 - accepted, 0 - not accepted

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Remove the user from the company

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

user_id
required
number

User ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}

Deprecated. Get company users Deprecated

location User object

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}

Clients

Client management including search, bulk operations, files, comments, and visit history.

Deprecated. Get a list of clients Deprecated

  • Parameter
    • company_id (required, number, 1) - company ID
    • page (number, 1) - Page number
    • count (number, 20) - Number of clients per page

Client filtering

  • fullname:Joh (optional, string) - Name (part of name) to filter clients
  • phone:7916 (optional, string) - Phone (part of the number) for filtering clients
  • email:test@ (optional, string) - Email (part) for client filtering
  • card:5663rt (optional, string) - Card (part) for filtering customers by loyalty card number
  • paid_min:100 (optional, number) - Minimum paid to the cashier, to filter customers by the amount of payments
  • paid_max:0 (optional, number) - Maximum paid to the cashier, to filter customers by the amount of payments
  • paid_max:0 (optional, number) - Maximum paid to the cashier, to filter customers by the amount of payments
  • id:66 (optional, number) - ID of one client for filtering clients
  • id[]: 66 (optional, array) - IDs of multiple clients to filter
  • changed_after: '2000-01-01T00:00:00' (optional, string) - Filtering clients changed/created since a specific date and time
  • changed_before: '2020-12-31T23:59:59' (optional, string) - Filtering clients changed/created before a specific date and time
Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

query Parameters
fullname
string
Example: fullname=Joh

Name (part of the name) for client filtering

phone
string
Example: phone=7916

Phone (part of the number) for customer filtering

email
string
Example: email=test@

Email (part) for customer filtering

paid_min
number
Example: paid_min=1

Minimum paid to the cashier, to filter customers by the amount of payments

paid_max
number
Example: paid_max=1

Maximum paid to the cashier, to filter customers by the amount of payments

page
number
Example: page=1

Page number

count
number
Example: count=20

Number of customers per page

location_id
number
Example: location_id=66

ID of one or more clients to filter clients

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Adding a Client

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: */*
optional
name
required
string

Client name

surname
string

Client surname

patronymic
string

Client middle name

phone
required
string

Customer phone

email
string

Client Email

sex_id
number

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

importance_id
number

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

discount
number

Customer Discount

card
string

Client card number

birth_date
string

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

comment
string

A comment

spent
number

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

balance
number

Client balance

sms_check
number

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

sms_not
number

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

categories
object

Array of customer category IDs

object

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get a list of clients

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

header Parameters
Accept
required
string

application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
required
page
number

Page number

page_size
number

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

fields
Array of strings

Fields to be returned in the response

order_by
string
Enum: "id" "name" "phone" "email" "discount" "first_visit_date" "last_visit_date" "sold_amount" "visit_count"

What field to sort by

order_by_direction
string
Enum: "ASC" "DESC"

How to sort (ascending / descending)

operation
string
Enum: "AND" "OR"

Type of transaction

Array of objects

Filters for searching by customers

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 3,
  • "fields": [
    ],
  • "order_by": "name",
  • "order_by_direction": "desc",
  • "operation": "AND",
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Get a client

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

id
required
number

Client ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Edit client

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

id
required
number

Client ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: */*
optional
name
required
string

Client name

surname
string

Client surname

patronymic
string

Client middle name

phone
required
string

Customer phone

email
string

Client Email

sex_id
number

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

importance_id
number

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

discount
number

Customer Discount

card
string

Client card number

birth_date
string

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

comment
string

A comment

spent
number

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

balance
number

Client balance

sms_check
number

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

sms_not
number

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

labels
object

Array of customer category IDs

object

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Delete client

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

id
required
number

Client ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}

Bulk adding clients

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: */*
optional
name
required
string

Client name

surname
string

Client surname

patronymic
string

Client middle name

phone
required
string

Customer phone

email
string

Client Email

sex_id
number

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

importance_id
number

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

discount
number

Customer Discount

card
string

Client card number

birth_date
string

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

comment
string

A comment

spent
number

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

balance
number

Client balance

sms_check
number

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

sms_not
number

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

categories
object

Array of customer category IDs

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

List of a comments for a client

Returns a list of a comments for a client and a files in a client details uploads history.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

client_id
required
number
Example: 123

ID of a location client.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Add a comment for a client

Creates a new text comment for a client.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

client_id
required
number
Example: 123

ID of a location client.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
text
required
string

Text of a comment for a client.

Responses

Request samples

Content type
application/json
{
  • "text": "Comment for a client"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Delete a comment for a client

Deletes a comment for a client; does not delete files uploaded that triggered creation of a comment.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

client_id
required
number
Example: 123

ID of a location client.

comment_id
required
number
Example: 123

ID of a comment for client.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}

Sample Request to Get a List of Client Files

A list of uploaded client files can be retrieved by providing both the location ID and the client ID in the request. The client ID can be obtained from the client collection.

The response returns an array of client files.

Each client file has the following structure:

| Field | Type | Description | | -----------------| ------- | -------------------------------------------------- ------------------------ | | id | number | File ID | | client_id | number | Client ID | | name | string | Filename with extension | | description | string | File description | | extension | string | File name extension | | mime | string | MIME file type | | link | string | File download link | | date_create | string | File upload date in ISO8601 format | | size | string | Formatted file size string | | username | string | The name of the user who uploaded the file | | user_avatar | string | Avatar of the user who uploaded the file | | can_edit | boolean | Is there a right to change and delete the file? true - there is a right, false - there is no right |

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

client_id
required
number

Client ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Delete request example

Authorizations:
bearer
path Parameters
location_id
required
number

location ID

client_id
required
number

Client ID

file_id
required
number

File ID

header Parameters
Accept
string
Example: application/vnd.api.v2+json

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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}

Search by customer history

Displays the client’s visit history.This method returns the client’s appointment and product purchase history, grouped by visit. Data is filtered based on visit status and paid status. The client is identified using either the client_id or client_phone parameter. All other parameters are optional. Results are sorted by visit date and paginated in batches of 25 items. If multiple visits share the same date as the last item on the page, they will be included on the current page to ensure complete grouping. To retrieve the next page, use the from and to values provided in the meta field of the current response.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
client_id
required
number or null

Client ID.

client_phone
required
string or null

Customer phone number.

from
required
string or null <date>

Period start date.

to
required
string or null <date>

Period end date.

payment_statuses
required
Array of strings
Items Enum: "not_paid" "paid_not_full" "paid_full" "paid_over"

Visit payment status:
not_paid - the visit is not paid, no payments were made for the visit;
paid_not_full - the visit is partially paid;
paid_full - the visit is paid in full, there is no overpayment;
paid_over - there is an overpayment for the visit.
If the filter by payment status is not required, then an empty array [] must be passed.

attendance
required
number or null
Enum: -1 0 1 2

Visit status: -1: - the client did not come; 0: - waiting for the client; 1: - the client has arrived; 2: - the client has confirmed the appointment.

Responses

Request samples

Content type
application/json
{
  • "client_id": 123,
  • "client_phone": 79998887766,
  • "from": "2022-01-31",
  • "to": "2022-02-01",
  • "payment_statuses": [
    ],
  • "attendance": -1
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": {
    }
}

Users & Permissions

User account management, roles, permissions, and invitations. Control access to location features.

Get a list of rights

  • Parameter
    • company_id (required, number, 1) - company ID
Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Getting a list of user roles

Returns a list of user roles along with permissions for each role.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

query Parameters
include
Array of strings
Items Value: "user_permissions"

Requested set of an included models.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": { }
}

Getting a list of user roles in the context of a company user

Returns a list of user roles along with permissions for each role. Allows to get the editable status for each permission of a company user (is_editable field). This status depends on the current user's permissions.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

user_id
required
number
Example: 123

ID of a user.

query Parameters
include
Array of strings
Items Value: "user_permissions"

Requested set of an included models.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": { }
}

Getting permission values and user role

Return user role and list of permissions values.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

user_id
required
number
Example: 123

ID of a user.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Updating permission values and user role

Updates the role and permissions of the user, as well as the employee who is attached to this user.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

user_id
required
number
Example: 123

ID of a user.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
user_role
string
Enum: "worker" "administrator" "accountant" "manager" "owner"

Name of role

Array of objects (Model object "Permission value")

List of user permissions values

staff_id
number

team member ID attached to user

Responses

Request samples

Content type
application/json
{
  • "user_role": "worker",
  • "user_permissions": [
    ],
  • "staff_id": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Create and Send an Invitation

An invitation to manage a location is sent via email or phone as a link. By following the link and completing registration, the user gains access to manage the location according to the permissions assigned. Permission assignment is performed in a separate request after the invitation is sent.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
required
Array of objects

Array of invites

Responses

Request samples

Content type
application/json
{
  • "invites": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}

Copy a User to Companies

Copies an active user and their permissions to multiple companies at once. If the user does not yet exist in a company, they will be added as an active user. If the user has already been invited to the company, only their permissions will be updated — however, they will still need to accept the invitation.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

user_id
required
number
Example: 123

ID of a user.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
required
Array of objects non-empty unique

List of locations to copy the user to

Responses

Request samples

Content type
application/json
{
  • "user_company_links": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}

Removing a User from Companies

Removes an active user from multiple companies at once.

Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
Example: 123

ID of a location.

user_id
required
number
Example: 123

ID of a user.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
required
Array of objects non-empty unique

List of locations to remove the user from

Responses

Request samples

Content type
application/json
{
  • "user_company_links": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}

Appointments

Appointment and visit management.

Key concepts:

  • Appointment (record) — A single scheduled service for a client with a specific team member at a specific time
  • Visit — A container that groups multiple appointments when a client books several services in one session

Example: Client books haircut + coloring → 1 visit containing 2 appointments

This section covers creating, modifying, and managing both individual appointments and visit containers.

Get list of appointments

Filtering Appointments

  • staff_id: team member ID.

Use this to retrieve appointments for a specific team member

  • client_id: Client ID

Use this to retrieve appointments for a specific client

  • created_user_id: User ID

User who created the appointment

Use this to filter appointments created by a specific user

  • start_date: Session start date (inclusive)

Returns appointments with a session starting on or after this date

  • end_date: Session end date (inclusive)

Returns appointments with a session ending on or before this date

  • c_start_date: Appointment creation date from

Returns appointments created on or after this date

  • c_end_date: Appointment creation date until

Returns appointments created on or before this date

  • changed_after: Modified or created after this datetime

Returns appointments created or modified after the specified date and time

  • changed_before: Modified or created before this datetime

Returns appointments created or modified before the specified date and time

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

query Parameters
page
number
Example: page=1

Page number

count
number
Example: count=50

Number of appointments per page

team_member_id
number
Example: team_member_id=7572

team member ID, if you only need appointments for a specific team member

client_id
number
Example: client_id=572

Client ID. If you need appointments for a specific client

created_user_id
number
Example: created_user_id=7572

The ID of the user who created the appointment. If you need appointments created by a specific user

start_date
string
Example: start_date=2025-01-21

Session date starting at (filter by session date). If you need appointments for a session starting from a specific date

end_date
string
Example: end_date=2025-01-21

Session date to. If you need appointments for a session before a specific date

c_start_date
string
Example: c_start_date=2025-01-21

Appointment creation date starting from(filter by appointment creation date). If you need appointments created since a specific date

c_end_date
string
Example: c_end_date=2025-01-21

Appointment creation date by (filter by appointment creation date).

changed_after
string
Example: changed_after=2025-01-21T23:00:00

The date the appointment was modified/created. If you need appointments created/modified starting from a specific date and time

changed_before
string
Example: changed_before=2025-01-21T23:00:00

The date the appointment was modified/created. If you need appointments created/modified before a specific date and time

include_consumables
number

Flag for including a list of consumables by appointments in the response

include_finance_transactions
number

Flag to include in the response financial transactions by appointments

with_deleted
boolean

Include deleted appointments in output (with_deleted=1 will return deleted appointments as well)

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Create a New Appointment

When creating an appointment for a group event, the event_id parameter becomes mandatory. In this case, the following parameters become optional:

  • staff_id
  • services
  • datetime
  • session_length

Additional fields You can pass custom values using additional fields created specifically for your location (see the "Additional Fields" section for setup details). Once created, these fields can be included in the custom_fields object when creating an appointment. Each key in this object must match the code of the corresponding additional field. Example:

  • If your location has the following additional fields: my_custom_field with type="number" some_another_field with type="list"

  • You can pass their values during appointment creation as follows: custom_fields:

{ "my_custom_field": 123, "some_another_field": ["first value", "second value"] }

  • When this appointment is later retrieved using the GET method, the same custom field values will be returned in the response.
Authorizations:
(beareruser)
path Parameters
location_id
required
number
Example: 24699

location ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
required
staff_id
number

team member ID

Array of objects

Service parameters (id, cost, discount)

object

Client parameters (phone, name, email)

save_if_busy
boolean

Whether to keep the appointment if the time is busy or non-working, or give an error

datetime
string <date-time>

Date and time of appointment

seance_length
number

Appointment duration in seconds

send_sms
boolean

Whether to send SMS with the details of the appointment to the client

comment
string

Appointment Comment

sms_remain_hours
number

Specifies how many hours before the visit an SMS reminder should be sent to the client. Set to 0 if no reminder is needed.

email_remain_hours
number

Specifies how many hours before the visit an email reminder should be sent to the client. Set to 0 if no reminder is needed.

attendance
number

Appointment status (2 - User confirmed the appointment, 1 - User came, services provided, 0 - user waiting, -1 - user did not show)

api_id
string

External system ID

custom_color
string

Appointment color

record_labels
Array of strings

Array of post category IDs

object

Additional appointment fields

Responses

Request samples

Content type
application/json
{
  • "staff_id": 8886,
  • "services": [
    ],
  • "client": {},
  • "save_if_busy": false,
  • "datetime": "2025-09-21T23:00:00.000+03:00",
  • "seance_length": 3600,
  • "send_sms": true,
  • "comment": "test appointment!",
  • "sms_remain_hours": 6,
  • "email_remain_hours": 24,
  • "attendance": 1,
  • "api_id": "777",
  • "custom_color": "f44336",
  • "record_labels": [
    ],
  • "custom_fields": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Get an Appointment

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

record_id
required
number

Appointment ID

query Parameters
include_consumables
number
include_finance_transactions
number
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Edit Appointment

When an appointment is changed in a group event, the event_id parameter becomes required, staff_id, services, datetime, session_length parameters become optional

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

record_id
required
number

Appointment ID

query Parameters
include_consumables
number
include_finance_transactions
number
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
required
staff_id
number

team member ID

Array of objects

Service parameters (id, cost, discount)

object

Client parameters (phone, name, email)

save_if_busy
boolean

Whether to keep the appointment if the time is busy or non-working, or give an error

datetime
string <date-time>

Date and time of appointment

seance_length
number

Appointment duration in seconds

send_sms
boolean

Whether to send SMS with the details of the appointment to the client

comment
string

Appointment Comment

sms_remain_hours
number

Specifies how many hours before the visit an SMS reminder should be sent to the client. Set to 0 if no reminder is needed.

email_remain_hours
number

Specifies how many hours before the visit an email reminder should be sent to the client. Set to 0 if no reminder is needed.

attendance
number

Appointment status (2 - User confirmed the appointment, 1 - User came, services provided, 0 - user waiting, -1 - user did not show)

api_id
string

External system ID

custom_color
string

Appointment color

record_labels
Array of strings

Array of post category IDs

object

Additional appointment fields

Responses

Request samples

Content type
application/json
{
  • "staff_id": 8886,
  • "services": [
    ],
  • "client": {},
  • "save_if_busy": false,
  • "datetime": "2025-09-21T23:00:00.000+03:00",
  • "seance_length": 3600,
  • "send_sms": true,
  • "comment": "test appointment!",
  • "sms_remain_hours": 6,
  • "email_remain_hours": 24,
  • "attendance": 1,
  • "api_id": "777",
  • "custom_color": "f44336",
  • "record_labels": [
    ],
  • "custom_fields": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Delete Appointment

Authorizations:
(beareruser)
path Parameters
location_id
required
number

location ID

record_id
required
number

Appointment ID

query Parameters
include_consumables
number
include_finance_transactions
number
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}

Get a List of Partner Appointments

Filtering appointments

  • salon_id: Location ID

Use this to filter appointments for a specific location

  • start_date: Visit date from

Filters appointments with a visit date starting from the specified date (inclusive)

  • end_date: Visit date until

Filters appointments with a visit date up to the specified date (inclusive)

  • created_start_date: Appointment creation date from

Filters appointments created on or after this date

  • created_end_date: Appointment creation date until

Returns appointments created on or before this date

  • user_id: User ID

Filters appointments created by a specific user

Authorizations:
(beareruser)
query Parameters
page
number
Example: page=1

Page number

editable_length
number
Example: editable_length=50

Number of appointments per page, maximum 100

salon_id
number
Example: salon_id=1

Location ID

start_date
string
Example: start_date='17.01.2025'

Filter by visit date from

end_date
string
Example: end_date='17.01.2025'

Filter by visit date by

created_start_date
string
Example: created_start_date='17.01.2025'

Filter by appointment creation date from

created_end_date
string
Example: created_end_date='17.01.2025'

Filter by appointment creation date by

user_id
number
Example: user_id=1

User ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Receipt PDF for the visit

Authorizations:
(beareruser)
path Parameters
visit_id
required
number
Example: 12345
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/pdf
Get comments 
The comment object has the following fields:






Field
Type
Description





id
number
Comment ID




salon_id
number
location ID




type
number
1 - comment to the team member, 0 - to the salon




master_id
number
Team Member ID if type = 1




text
string
Comment text




date
string
Date when the comment was left




rating
number
Rating (from 1 to 5)




user_id
number
Id of the user who left the comment




username
string
Name of the user who left the comment




user_avatar
string
Avatar of the user who left the comment




record_id
number
ID of the post after which the review was left (the value will be non-zero if the review was left through a link asking for a review after the visit)





Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
start_date
string
 
date in iso8601 format.
Filter by date since (for example '2015-09-30')


end_date
string
 
date in iso8601 format.
Filter by date by (for example '2015-09-30')


team_member_id
number
 
team member ID


rating
number
 
Rating score. Filter by reviews with a specific rating.


page
number
 
Page number


count
number
 
Number of reviews per page


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Leave a Comment 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


team_member_id
required
number
 
team member ID, specify when creating a review for a team member


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
mark
required
number
 
Rating from 1 to 5


text
required
string
 
Feedback text


name
required
string
 
Username to be displayed on the review page


Responses
 Request samples 
Content type
application/json
{
  • "mark": 4,
  • "text": "Everything is very bad!",
  • "name": "Victor"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Activities & Events
Class and event management for group activities. Schedule and manage group sessions.


Group Event Search 
Authorizations:
BearerPartner
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


query Parameters
from
required
string
 
 Example:  from=2023-06-01
Search start date (YYYY-MM-DD format).


till
required
string
 
 Example:  till=2023-07-15
Search end date (YYYY-MM-DD format).


service_ids
Array of integers
 
 Example:  service_ids=123
Filter by services IDs.


staff_ids
Array of integers
 
 Example:  staff_ids=456
Filter by staff IDs.


resource_ids
Array of integers
 
 Example:  resource_ids=789
Filter by resources IDs.


page
number
 
 Example:  page=1
Page number (default 1).


count
number
 
 Example:  count=25
Page size (default 25).


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Finding dates for group events 
Authorizations:
BearerPartner
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


query Parameters
from
required
string
 
 Example:  from=2023-06-01
Search start date (YYYY-MM-DD format).


till
required
string
 
 Example:  till=2023-07-15
Search end date (YYYY-MM-DD format).


service_ids
Array of integers
 
 Example:  service_ids=123
Filter by services IDs.


staff_ids
Array of integers
 
 Example:  staff_ids=456
Filter by staff IDs.


resource_ids
Array of integers
 
 Example:  resource_ids=789
Filter by resources IDs.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Finding dates range for group events 
Authorizations:
BearerPartner
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


query Parameters
service_ids
Array of integers
 
 Example:  service_ids=123
Filter by services IDs.


staff_ids
Array of integers
 
 Example:  staff_ids=456
Filter by staff IDs.


resource_ids
Array of integers
 
 Example:  resource_ids=789
Filter by resources IDs.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Group events search filters 
Authorizations:
BearerPartner
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


query Parameters
service_ids
Array of integers
 
 Example:  service_ids=123
Filter by services IDs.


staff_ids
Array of integers
 
 Example:  staff_ids=456
Filter by staff IDs.


resource_ids
Array of integers
 
 Example:  resource_ids=789
Filter by resources IDs.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Search for group services 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
 Example:  4564
location ID


query Parameters
staff_id
number
 
team member ID to filter


term
string
 
Search by name or part of the service name


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
staff_id
number
 
team member ID to filter


term
string
 
Search by name or part of the service name


Responses
 Request samples 
Content type
application/json
{
  • "staff_id": 1,
  • "term": "test"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Getting Duplication Strategies for Group Events 
Duplication of events occurs based on a set of parameters combined in the "duplication strategy" entity






Field
Type
Description





title
string
Strategy name




repeat_mode_id
integer
Repeat mode




days
integer[]
List of days of the week: 0 Sun, 6 Fri




interval
integer
Break in searching for dates, in units of type




content_type
integer
Duplicate appointments? 1 - no, 2 - yes





The repeat mode can take the values






Meaning
Description
Break unit





1
Daily
Day




2
Weekdays
-




3
Mon Wed Fri
-




4
Tue Thu
-




5
Every week
Week




6
Every month
Month




7
Every year
Year





The days field is relevant only for mode 5 - week, for specifying specific days of repetition
If you specify repeat_mode = 5, days = [1,4], interval = 2, then the event will be
repeat every 3rd week on mon and thurs


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
 Example:  4564
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Create a Duplicate Group Event Template 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
optional
title
required
string
 
Name


days
Array of objects
 
Recurrence Days for Weekly Mode


repeat_mode_id
required
number
 
Repeat Mode


interval
number
 
Break in searching for dates


content_type
number
 
Duplicate appointments? 1 - no, 2 - yes


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Group Event Duplicate Template Update 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
 Example:  4564
location ID


strategy_id
required
number
 
 Example:  3
Replication strategy ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
optional
title
required
string
 
Name


days
Array of objects
 
Recurrence Days for Weekly Mode


repeat_mode_id
required
number
 
Repeat Mode


interval
number
 
Break in searching for dates


content_type
number
 
Duplicate appointments? 1 - no, 2 - yes


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Create a group event 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
date
required
string <date-time> 
 
date and time


service_id
required
number
 
Service ID


staff_id
required
number
 
team member ID


capacity
required
number
 
Capacity


resource_instance_ids
Array of numbers
 
Array of resource instance IDs


force
required
boolean
 
Ignore errors (busy team member/resources, etc.)


length
number
 
Event duration in seconds


Responses
 Request samples 
Content type
application/json
{
  • "date": "2017-10-10 15:30",
  • "service_id": 1185299,
  • "staff_id": 26427,
  • "length": 3600,
  • "capacity": 9,
  • "resource_instance_ids": [
    ],
  • "force": false
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Reading a Group Event 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


activity_id
required
integer
 
group  event ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Group event update 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


activity_id
required
integer
 
Group Event ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
date
required
string <date-time> 
 
date and time


service_id
required
number
 
Service ID


staff_id
required
number
 
team member ID


capacity
required
number
 
Capacity


resource_instance_ids
Array of numbers
 
Array of resource instance IDs


force
required
boolean
 
Ignore errors (busy team member/resources, etc.)


length
number
 
Event duration in seconds


Responses
 Request samples 
Content type
application/json
{
  • "date": "2017-10-10 15:30",
  • "service_id": 1185299,
  • "staff_id": 26427,
  • "length": 3600,
  • "capacity": 9,
  • "resource_instance_ids": [
    ],
  • "force": false
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Deleting a Group Event 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


activity_id
required
integer
 
group  event ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Group Event Duplicate Request 
A request for duplication can be made in 3 ways:


    

  • Specifying a list of dates and times to duplicate
    

    • 

  • Specifying the id of the repetition strategy
    

    • 

  • By specifying all repetition parameters
    

    • 



Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
 Example:  1
activity_id
required
integer
 
 Example:  2
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
optional
object
 
Responses
 Request samples 
Content type
application/json
{ }
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Create group event (v2) 
Creates a group event using the new v2 API.


Note: This is the v2 version of group events API with enhanced features.


path Parameters
location_id
required
integer
 
 Example:  1
Location (business) ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
API version header


Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Request Body schema: application/json
required
staff_id
required
integer
 
Team member (staff) ID who will conduct the event.


service_id
required
integer
 
Service ID for this event.


resource_instance_ids
required
Array of integers
 
List of resource instance IDs (required, can be empty array).


label_ids
required
Array of integers
 
List of category/label IDs (required, can be empty array).


date
required
string <date-time> 
 
Event date and time.


length
required
integer
 
Event duration in seconds.


integer or null
 
Technical break duration in seconds.


    

  • If not provided: defaults to null
    • 

  • Value null: uses location's default setting (Settings → Timetable → Technical breaks) or keeps current value when updating
    • 

  • If value > 0: break duration must be included in the length parameter (length = services + break)
    • 

  • Accepts only multiples of 300 (5-minute intervals)
    • 

  • Maximum value: 3600 (1 hour)
    • 



capacity
required
integer
 
Number of available slots for this event.


comment
string
 
Event comment or description.


color
string
 
Event color (hex format).


instructions
string
 
Instructions for the event.


stream_link
string
 
Stream link for online events.


force
boolean
 Default:  false
 
Skip resource availability check (true - skip check, false - validate).


Responses
 Request samples 
Content type
application/json
{
  • "staff_id": 1,
  • "service_id": 500,
  • "resource_instance_ids": [
    ],
  • "label_ids": [
    ],
  • "date": "2024-11-22 14:00:00",
  • "length": 3600,
  • "technical_break_duration": 300,
  • "capacity": 4,
  • "comment": "Beginner group session",
  • "color": "#9c27b0",
  • "instructions": "Bring two balls",
  • "stream_link": "https://stream.com/some_link",
  • "force": false
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}
Get group event details (v2) 
Returns detailed information about a specific group event using v2 API.


path Parameters
location_id
required
integer
 
Location (business) ID


activity_id
required
integer
 
Activity ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
API version header


Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}
Update group event (v2) 
Updates an existing group event using v2 API.


path Parameters
location_id
required
integer
 
Location (business) ID


activity_id
required
integer
 
Activity ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Request Body schema: application/json
required
staff_id
required
integer
 
Team member (staff) ID


service_id
required
integer
 
Service ID


resource_instance_ids
required
Array of integers
 
List of resource instance IDs (required, can be empty)


label_ids
required
Array of integers
 
List of category/label IDs (required, can be empty)


date
required
string <date-time> 
 
Event date and time


length
required
integer
 
Event duration in seconds


integer or null
 
Technical break duration (multiples of 300, max 3600)


capacity
required
integer
 
Number of available slots


comment
string
 
Event comment


color
string
 
Event color (hex format)


instructions
string
 
Instructions for the event


stream_link
string
 
Stream link for online events


force
boolean
 Default:  false
 
Skip resource availability check


Responses
 Request samples 
Content type
application/json
{
  • "staff_id": 0,
  • "service_id": 0,
  • "resource_instance_ids": [
    ],
  • "label_ids": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "length": 0,
  • "technical_break_duration": 0,
  • "capacity": 0,
  • "comment": "string",
  • "color": "string",
  • "instructions": "string",
  • "stream_link": "string",
  • "force": false
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}
Delete group event (v2) 
Deletes a group event using v2 API.


path Parameters
location_id
required
integer
 
Location (business) ID


activity_id
required
integer
 
Activity ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Responses
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": { }
}
Create booking in group event (v2) 
Creates a booking (appointment record) for a client in a group event using v2 API.


Note: All client fields are required even when using existing client ID.


path Parameters
location_id
required
integer
 
Location (business) ID


activity_id
required
integer
 
Activity ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Request Body schema: application/json
required
client_id
integer
 
Existing client ID (deprecated, use client.id instead)


required
object
 
Client information


comer_id
integer
 
Visitor ID (alternative to client)


object
 
Visitor information (alternative to client)


labels
Array of integers
 
Label/category IDs for this booking


clients_count
required
integer
 
Number of participants/slots to reserve


Responses
 Request samples 
Content type
application/json
{
  • "client_id": 123456,
  • "client": {
    },
  • "comer_id": 500,
  • "comer": {
    },
  • "labels": [
    ],
  • "clients_count": 1
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}
Update booking in group event (v2) 
Updates an existing booking (appointment record) in a group event using v2 API.


Note: This endpoint uses PATCH (not POST as in some documentation).


path Parameters
location_id
required
integer
 
Location (business) ID


activity_id
required
integer
 
Activity ID


record_id
required
integer
 
Record (booking) ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Request Body schema: application/json
required
reschedule_activity_id
required
integer
 
Activity ID to reschedule this booking to (required field)


object
 
Service pricing information


Array of objects
 
Products/goods associated with this booking


comment
string
 
Booking comment


label_ids
Array of integers
 
Label/category IDs


color
string
 
Booking color (hex without


clients_count
integer
 
Number of participants


Responses
 Request samples 
Content type
application/json
{
  • "reschedule_activity_id": 12345,
  • "attendance_service_item": {
    },
  • "attendance_good_items": [
    ],
  • "comment": "Updated booking comment",
  • "label_ids": [
    ],
  • "color": "f44336",
  • "clients_count": 2
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": { }
}
Schedule & Resources
Work schedules, available time slots, resources, and timetable management for team members and facilities.


Create a Client Schedule 
Creates a client schedule with a series of appointments for events, based on an existing schedule..


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


schedule_id
required
integer
 
 Example:  123
ID of a schedule.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Request Body schema: application/json
client_id
required
number
 
ID of client for creating a client schedule.


comer_id
number
 
ID of client`s comer for creating a client schedule.


schedule_days_ids
required
Array of numbers  [ 1 .. 7 ] items 
 
IDs of schedule series, min of 1 series, max of 7 series.


Responses
 Request samples 
Content type
application/json
{
  • "client_id": 123,
  • "comer_id": 123,
  • "schedule_days_ids": [
    ]
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}
Update a Client Schedule 
Updates the client schedule by attaching or detaching a schedule series, which results in appointments for future events being created or removed.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


schedule_id
required
integer
 
 Example:  123
ID of a schedule.


client_schedule_id
required
number
 
 Example:  123
ID of a client schedule.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Request Body schema: application/json
schedule_days_ids
required
Array of numbers  [ 1 .. 7 ] items 
 
IDs of schedule series, min of 1 series, max of 7 series.


Responses
 Request samples 
Content type
application/json
{
  • "schedule_days_ids": [
    ]
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}
Delete a Client Schedule 
Deletes a client schedule, including all associated future appointments for scheduled events.


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


schedule_id
required
integer
 
 Example:  123
ID of a schedule.


client_schedule_id
required
number
 
 Example:  123
ID of a client schedule.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}
Get schedule of a specific team member 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


team_member_id
required
number
 
team member ID.


start_date
required
number
 
 Example:  20251201
Period start date


end_date
required
number
 
 Example:  20251231
Period end date


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Change schedule of a specific team member 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


team_member_id
required
number
 
team member ID


start_date
required
string <date> 
 
Start date (YYYY-MM-DD)


end_date
required
string <date> 
 
End date (YYYY-MM-DD)


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
optional
date
required
string
 
date


is_working
required
boolean
 
Working date or not


slots
required
object
 
Array of (from, to) working hours


Responses
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Get a list of dates for Appointment Calendar 
The Appointment Calendar dates are returned as an array of date strings, for example: ["2015-10-26", "2015-10-30"]. To retrieve this list, you must provide a reference date. The response will return the available working dates of the specified location or team member relative to that date


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


date
required
string
 
date in iso8601 format.
Filter by appointment date (eg '2015-09-30')


query Parameters
staff_id
number
 
team member ID.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Get a list of sessions for the Appointment Calendar 
The sessions object for the log has the following fields:






Field
Type
Description





time
string
Session time (17:30 for example)




free
boolean
Free time or busy





Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


date
required
string
 
date in iso8601 format.
Filter by appointment date (eg '2015-09-30')


team_member_id
required
number
 
team member ID.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Getting Resources at a Location 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Search a Schedule by Event 
Search for a schedule based on the appointment or event linked to it, or based on the associated appointment or event.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


entity_type
required
string
 Enum: "record" "activity" 
 
 Example:  activity
Type of an entity schedule is searched by:
record - individual appointment, currently not supported;
activity - group event.


entity_id
required
number
 
 Example:  123
ID of an entity schedule is searched by.


query Parameters
include
Array of strings
Items Enum: "days" "days.events_master" "days.events_labels" "days.events_resource_instances" 
 
Requested set of an included models.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}
Create a Schedule 
Creates a schedule for appointments or events based on the original associated entity.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


query Parameters
include
Array of strings
Items Value: "days" 
 
Requested set of an included models.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Request Body schema: application/json
original_entity_type
required
string
 Enum: "record" "activity" 
 
Type of entity the schedule will be based on:
record - individual appointment, currently not supported;
activity - group event.


original_entity_id
required
number
 
ID of entity the schedule will be based on.


date_end
required
string <date> 
 
Date of the schedule end.


add_clients_from_original_entity
required
boolean
 
Add clients from original entity to all scheduled events.


required
Array of objects  [ 1 .. 7 ] items 
 
Each object represents schedule series settings for a specific day of the week. A minimum of 1 and a maximum of 7 schedule series can be defined (one for each day of the week).


Responses
 Request samples 
Content type
application/json
{
  • "original_entity_type": "activity",
  • "original_entity_id": 123,
  • "date_end": "2022-02-01",
  • "add_clients_from_original_entity": false,
  • "days": [
    ]
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}
Update a Schedule 
Updates the settings of a schedule containing appointments or events.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


schedule_id
required
integer
 
 Example:  123
ID of a schedule.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Request Body schema: application/json
date_end
string <date> 
 
Date of the schedule end.


Responses
 Request samples 
Content type
application/json
{
  • "date_end": "2022-02-01"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}
Delete a Schedule 
Completely deletes a schedule along with all its series and the linked appointments or events.


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


schedule_id
required
integer
 
 Example:  123
ID of a schedule.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}
Create a Schedule Series 
Adds a new series to an existing schedule of appointments or events.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


schedule_id
required
integer
 
 Example:  123
ID of a schedule.


query Parameters
include
Array of strings
Items Enum: "events_master" "events_labels" "events_resource_instances" "events" 
 
Requested set of an included models.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Request Body schema: application/json
day_of_week
required
string
 Enum: "mon" "tue" "wed" "thu" "fri" "sat" "sun" 
 
The day of the week for the schedule series.


events_master_id
required
number
 
The ID of the team member assigned to the events in the schedule series.


events_time
required
string
 
Start time of the events in the schedule series, formatted as HH:MM:SS.


events_duration
required
number
 
Duration of each event in the schedule series, in seconds.


events_capacity
required
number
 
The capacity of activities in the schedule series. For appointments, this should be set to 1.


labels_ids
Array of numbers
 
An array of label IDs associated with the events in the schedule series.


resource_instances_ids
Array of numbers
 
An array of resource instance IDs used in the events of the schedule series.


Responses
 Request samples 
Content type
application/json
{
  • "day_of_week": "mon",
  • "events_master_id": 123,
  • "events_time": "14:00:00",
  • "events_duration": 3600,
  • "events_capacity": 4,
  • "labels_ids": [
    ],
  • "resource_instances_ids": [
    ]
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}
Update a schedule series 
Updates the settings of a schedule series for appointments or events.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


schedule_id
required
integer
 
 Example:  123
ID of a schedule.


day_id
required
number
 
 Example:  123
ID of a schedule series.


query Parameters
include
Array of strings
Items Enum: "events_master" "events_labels" "events_resource_instances" "events" 
 
Requested set of an included models.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Request Body schema: application/json
force
required
boolean
 
Flag for force override of manual changes in scheduled appointments/events.


events_master_id
number
 
The ID of the team member assigned to the events in the schedule series.


events_time
string
 
Start time of the events in the schedule series, formatted as HH:MM:SS.


events_duration
number
 
Duration of each event in the schedule series, in seconds.


events_capacity
number
 
The capacity of activities in the schedule series. For appointments, this should be set to 1.


labels_ids
Array of numbers
 
An array of label IDs associated with the events in the schedule series.


resource_instances_ids
Array of numbers
 
An array of resource instance IDs used in the events of the schedule series.


Responses
 Request samples 
Content type
application/json
{
  • "force": false,
  • "events_master_id": 123,
  • "events_time": "14:00:00",
  • "events_duration": 3600,
  • "events_capacity": 4,
  • "labels_ids": [
    ],
  • "resource_instances_ids": [
    ]
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}
Delete a schedule series 
Deletes a schedule series and all appointments or events linked to it.


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


schedule_id
required
integer
 
 Example:  123
ID of a schedule.


day_id
required
number
 
 Example:  123
ID of a schedule series.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}
Get a List of Scheduled Appointments and Events 
Prints  a list of events of scheduled records/activities.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


schedule_id
required
integer
 
 Example:  123
ID of a schedule.


day_id
required
number
 
 Example:  123
ID of a schedule series.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Retrieving Appointment Calendar Settings 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Update Appointment Calendar settings 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Request Body schema: application/json
required
record_type
required
integer  [ 0 .. 2 ] 
 
Default record type: 0 - Mixed appointment, 1 - Individual appointment, 2 - Group event


activity_record_clients_count_max
required
integer  [ 1 .. 255 ] 
 
Maximum number of seats in one group event


Responses
 Request samples 
Content type
application/json
{
  • "record_type": 0,
  • "activity_record_clients_count_max": 1
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Products
Product catalog management. Define products available for sale and organize them into categories.


Search products and categories 
List of products and product categories


You can retrieve a list of products and product categories by providing the location ID. Use the search_term parameter to filter: 


    

  • Product categories by name or article 
    • 

  • Products by name, article, or barcode
    • 



Limit the number of results using the max_count parameter.


If search_term is not provided, the response will return a list of root categories for the specified location. In this case, the max_count parameter is ignored. If search_term is provided, the system will first search among categories. If fewer than max_count results are found, the search will continue among products to fill the remaining count.


The result is returned as an array of products tree elements.



Product tree element has the following structure:


| Field | Type | Description |
| -------------| ------- | -------------------------------------------------- ----------------------------------------- |
| parent_id | number | Parent element ID (0 for root elements) |
| item_id | number | Item ID (0 if item is a category) |
| category_id | number | Product category ID (0 if the item is a product) |
| title | string | Product name or product category |
| is_chain | boolean | Is the element chain-bound? true - the element is connected to the chain, false - not connected |
| is_category | boolean | Is the element a category? true - category, false - product |
| is_item | boolean | Is the item a product? true - product, false - category |


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
term
string
 
Search query by name, article number or barcode


count
number
 
The number of output lines per page. Maximum 100


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get Products 
    

  • term: Name, article or barcode
    

    • 

  • page (number, 1) - Page number (not used if good_id is passed)
    

    • 

  • count (number, 25) - Number of products on the page (not used if good_id is passed)
    

    • 

  • category_id (number, 777) - Id of the product category (not used if good_id is passed)
    

    • 

  • changed_after (string) - filtering products changed/created since a specific date and time (not used if good_id is passed)
    

    • 

  • changed_before (string) - filtering products changed/created before a specific date and time (not used if good_id is passed)
    

    • 



Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


good_id
required
number
 
Product ID (if you need to get a specific product)


query Parameters
term
string
 
name, article number or barcode


page
number
 
 Example:  page=1
page number


count
number
 
 Example:  count=25
number of products per page


category_id
number
 
Product category ID


changed_after
string
 
 Example:  changed_after=2025-09-21T23:00:00.000+03:00
filtering products modified/created since a specific date and time


changed_before
string
 
 Example:  changed_before=2017-01-01T12:00:00+0400
filtering products modified/created before a specific date and time


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Edit Products 
The method allows you to change the product parameters.
When editing units of measure for an item that already has inventory operations, you must add an array of rules for recalculating units of measure - correction_rules. Otherwise, the array is optional.


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


good_id
required
number
 
Item ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
title
required
string
 
Product Name


print_title
string
 
Title to be printed on receipt


article
string
 
vendor code


barcode
string
 
Barcode


category_id
required
integer
 
Product category ID


cost
number <float> 
 
Selling price


actual_cost
number <float> 
 
Cost price


sale_unit_id
required
integer
 
Sales unit


service_unit_id
required
integer
 
Write-off unit


unit_equals
number <float> 
 
The ratio of the unit of measure for sale to the unit of measure for write-off


critical_amount
number <float> 
 
critical residue


desired_amount
number <float> 
 
Desired balance


netto
number <float> 
 
Net weight


brutto
number <float> 
 
Gross weight


comment
string
 
A comment


tax_variant
integer
 
Taxation system


vat_id
integer
 
VAT


Array of objects
 
An array of rules for converting units of measurement (required if there are inventory operations for the product)


Responses
 Request samples 
Content type
application/json
{
  • "title": "Shampoo",
  • "print_title": "Shampoo",
  • "article": "123",
  • "barcode": "123",
  • "category_id": 289632,
  • "cost": 1000,
  • "actual_cost": 500,
  • "sale_unit_id": 216762,
  • "service_unit_id": 216762,
  • "unit_equals": 100,
  • "critical_amount": 1,
  • "desired_amount": 1,
  • "netto": 200,
  • "brutto": 250,
  • "comment": "Test comment 123",
  • "tax_variant": 0,
  • "vat_id": 3,
  • "correction_rules": [
    ]
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Delete Items 
The method allows you to remove the product


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


good_id
required
number
 
Item ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Get a list of products 
Returns a list of all products for the specified location


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Create product 
The method allows you to create a product


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
title
required
string
 
Product Name


print_title
string
 
Title to be printed on receipt


article
string
 
vendor code


barcode
string
 
Barcode


category_id
required
integer
 
Product category ID


cost
number <float> 
 
Selling price


actual_cost
number <float> 
 
Cost price


sale_unit_id
required
integer
 
Sales unit


service_unit_id
required
integer
 
Write-off unit


unit_equals
number <float> 
 
The ratio of the unit of measure for sale to the unit of measure for write-off


critical_amount
number <float> 
 
critical residue


desired_amount
number <float> 
 
Desired balance


netto
number <float> 
 
Net weight


brutto
number <float> 
 
Gross weight


comment
string
 
A comment


tax_variant
integer
 
Taxation system


vat_id
integer
 
VAT


Responses
 Request samples 
Content type
application/json
{
  • "title": "Shampoo",
  • "print_title": "Shampoo",
  • "article": "123",
  • "barcode": "123",
  • "category_id": 289632,
  • "cost": 1000,
  • "actual_cost": 500,
  • "sale_unit_id": 216762,
  • "service_unit_id": 216762,
  • "unit_equals": 100,
  • "critical_amount": 1,
  • "desired_amount": 1,
  • "netto": 200,
  • "brutto": 250,
  • "comment": "Test comment 123",
  • "tax_variant": 0,
  • "vat_id": 3
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Example of a request to get the composition of a category 
##№ Composition of the product category


Information on a product category and its descendants can be obtained by making a request specifying the location ID and product category.
Pagination is supported, specified by the page and count parameters.


Composition of a product category has the following structure:






Field
Type
Description





parent_id
number
Parent element ID (0 for root elements)




item_id
number
Item ID (always 0)




category_id
number
Product category ID




title
string
Product category name




is_chain
boolean
Is the element chain-bound? true - the element is connected to the chain, false - not connected




is_category
boolean
Is the element a category? always true




is_item
boolean
Is the item a product? always false




children
array of objects (Product tree element)
Child elements of a product category




children_count
number
Total number of child products and categories (no recursion)





Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


category_id
required
number
 
Product Category ID


query Parameters
page
number
 
Page number


count
number
 
The number of products displayed on the page. Maximum 1000


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    }
}
Example of a request to get categories 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


parent_category_id
required
number
 
ID of the parent product category


query Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get a list of product categories by ID 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
location_id
number
 
Product category ID (you can specify several additional parameters &ids[]={id}


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Create a Product Category 
The method allows you to create a product category.


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
title
required
string
 
Product category name


parent_category_id
integer <int32> 
 
Parent category ID (optional, but can be 0 or null if you don't need to specify the parent category)


article
string
 
vendor code


comment
string
 
A comment


Responses
 Request samples 
Content type
application/json
{
  • "title": "Manicure",
  • "parent_category_id": 123456,
  • "article": "123article",
  • "comment": "Category of products for manicure"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get a list of product categories  Deprecated 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


category_id
required
number
 
ID of the parent product category. Default 0 - top-level categories are displayed (optional)


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Edit a Product Category 
The method allows you to edit the product category


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


category_id
required
number
 
Product category ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
title
required
string
 
Product category name


parent_category_id
integer <int32> 
 
Parent category ID (optional, but can be 0 or null if you don't need to specify the parent category)


article
string
 
vendor code


comment
string
 
A comment


Responses
 Request samples 
Content type
application/json
{
  • "title": "Manicure",
  • "parent_category_id": 123456,
  • "article": "123article",
  • "comment": "Category of products for manicure"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Delete a Product Category 
The method allows you to delete a product category


Authorizations:
(userbearer) 
path Parameters
location_id
required
number
 
Location ID


category_id
required
number
 
Product category ID


header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Inventory
Stock management including storage locations, inventory documents, stock movements, and consumables tracking.


Get company inventories 
The location inventory object has the following fields:






Field
Type
Description





id
number
Inventory ID




title
string
Title




for_services
number
1 - if used for automatic write-off of consumables




for_sale
number
1 - if the default inventory for selling products




comment
string
Description of the inventory





Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Search for product transactions 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
page
number
 
 Example:  page=1
page number


count
number
 
 Example:  count=20
number of transactions per page


start_date
string
 
 Example:  start_date=''
period start date


end_date
string
 
 Example:  end_date=''
period end date


document_id
string
 
Document ID


changed_after
string
 
Filtering product transactions modified/created since a specific date and time


changed_before
string
 
Filtering product transactions modified/created before a specific date and time


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Create an inventory operation 
An inventory operation is created by submitting a document along with multiple product transactions in a single API request. If a payment type is specified, the corresponding financial transactions will be generated automatically.


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
required
type_id
required
number
 
Document type (Sale 1, Usage / Material Consumption 2, Product Receipt / Icoming 3, Inventory Write-off / Goods Disposal 4, Internal Transfer 5)


comment
string
 
A comment


create_date
required
string <date-time> 
 
Document creation date


master_id
number
 
team member ID


storage_id
required
number
 
Inventory ID


goods_transactions
required
Array of objects
 
An array of objects containing transaction parameters, similar to a request to create a product transaction


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Create document 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
type_id
required
number
 
Document type (sale 1, receipt 3, write-off 7)


comment
string
 
A comment


storage_id
required
number
 
Inventory ID


create_date
required
string <date-time> 
 
Date of the inventory transaction


Responses
 Request samples 
Content type
application/json
{
  • "type_id": 1,
  • "comment": "Document comment",
  • "storage_id": 36539,
  • "create_date": "2025-09-21T23:00:00.000+03:00"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get document 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


document_id
required
number
 
Document ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Update Document 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


document_id
required
number
 
Document ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
required
type_id
required
number
 
Document type (sale 1, receipt 3, write-off 7)


comment
string
 
A comment


storage_id
required
number
 
Inventory ID


create_date
required
string <date-time> 
 
Date of the inventory transaction


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Delete document 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


document_id
required
number
 
Document ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Create Transaction 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
document_id
required
number <float> 
 
Document ID


good_id
required
number
 
Item ID


amount
required
number
 
Quantity


cost_per_unit
required
number <float> 
 
Unit cost


discount
required
number
 
Discount in %


cost
required
number <float> 
 
Total transaction amount


operation_unit_type
required
number
 
unit type: 1 - for sale, 2 - for write-off


master_id
number
 
ID of the team member who sold the product


client_id
number
 
ID of the customer who bought the product


supplier_id
number
 
Vendor ID


comment
string
 
A comment


Responses
 Request samples 
Content type
application/json
{
  • "document_id": 22254960,
  • "good_id": 232674,
  • "amount": 1,
  • "cost_per_unit": 100,
  • "discount": 10,
  • "cost": 90,
  • "operation_unit_type": 1,
  • "master_id": 26781,
  • "client_id": 0,
  • "supplier_id": 0,
  • "comment": "Transaction comment"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Receiving a transaction 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


transaction_id
required
number
 
transaction ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Transaction update 
Authorizations:
(beareruser) 
path Parameters
transaction_id
required
number
 
transaction ID


location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
required
document_id
required
number <float> 
 
Document ID


good_id
required
number
 
Item ID


amount
required
number
 
Quantity


cost_per_unit
required
number <float> 
 
Unit cost


discount
required
number
 
Discount in %


cost
required
number <float> 
 
Total transaction amount


operation_unit_type
required
number
 
unit type: 1 - for sale, 2 - for write-off


master_id
number
 
ID of the team member who sold the product


client_id
number
 
ID of the customer who bought the product


supplier_id
number
 
Vendor ID


comment
string
 
A comment


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Deleting a transaction 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


transaction_id
required
number
 
transaction ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Get Product Transactions of a Document 
Authorizations:
(beareruser) 
path Parameters
document_id
required
number
 
Document ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Retrieve a list of bill of materials and consumables 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


query Parameters
search
string
 
 Example:  search='test'
parameter for searching by the name of those lists


page
number
 
 Example:  page=1
page number


count
number
 
 Example:  count=20
number of those lists per page


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Get the Bill of Materials for a Team Member’s Service 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


staff_id
required
number
 
team member ID


service_id
required
number
 
Service ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Retrieve a list of bill of materials and consumables 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


record_id
required
number
 
Appointment ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Update Consumables for the Appointment-Service Association 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


record_id
required
number
 
Appointment ID


service_id
required
number
 
Service ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
Array of objects
 
List of consumables


Responses
 Request samples 
Content type
application/json
{
  • "consumables": [
    ]
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Sales
Sales documents and receipts. View and manage point-of-sale transactions.


Receipt of a Sales Transaction 
Authorizations:
(beareruser) 
path Parameters
document_id
required
integer
 
Sales Document ID


location_id
required
number
 
Location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Payment at the Cash Desk and Loyalty (Various Methods) 
As a response, information about the Sale operation is returned


Authorizations:
(beareruser) 
path Parameters
document_id
required
number
 
Document ID


location_id
required
number
 
Location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
    

  1. In the case of payment by a gift card, if the user does not have the "Pay by gift card and membership without code" right, the "number" (string) parameter containing the gift card code must also be passed in the request body.
    2. 

  2. In the case of payment by membership, if the user does not have the "Pay by gift card and membership without code" right, the "number" (string) parameter containing the membership code must also be passed in the request body.
    3. 



 Any of 
object
 
Object containing the payment method


Responses
 Request samples 
Content type
application/json
Example
{
  • "payment": {
    }
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Delete a Loyalty Payment Transaction 
As a response, information about the Sale operation is returned


Authorizations:
(beareruser) 
path Parameters
document_id
required
integer
 
Sales Document ID


payment_transaction_id
required
integer
 
transaction ID


location_id
required
number
 
Location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Delete a Cashier Payment Transaction 
As a response, information about the Sale operation is returned


Authorizations:
(beareruser) 
path Parameters
document_id
required
integer
 
Sales Document ID


payment_transaction_id
required
integer
 
transaction ID


location_id
required
number
 
Location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Payments
Financial operations including cash registers, payment transactions, and all monetary movements.


Get company cash registers 
The location checkout object has the following fields:






Field
Type
Description





id
number
Checkout ID




title
string
Title




type
number
1 - for non-cash payments, 0 for cash




comment
string
Description to the checkout





Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Get transactions 
Transaction filtering


    

  • page: Page number
    

    • 

  • count: Number of customers per page
    

    • 

  • account_id: Checkout ID
    

    • 

  • supplier_id: Supplier ID
    

    • 

  • client_id: Client ID
    

    • 

  • user_id: user ID
    

    • 

  • master_id: team member ID
    

    • 

  • type: transaction type
    

    • 

  • real_money: Indicates whether this is a real-money (fiat) transaction
    

    • 

  • deleted: whether the transaction was deleted
    

    • 

  • start_date: start date of the period
    

    • 

  • end_date: end date of the period
    

    • 

  • balance_is: 0 - any balance, 1 - positive, 2 - negative
    

    • 

  • document_id: document ID
    

    • 



Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
page
number
 
 Example:  page=1
Page number


count
number
 
 Example:  count=50
Number of customers per page


account_id
number
 
Checkout ID


supplier_id
number
 
Supplier ID


client_id
number
 
Client ID


user_id
number
 
User ID


master_id
number
 
team member ID


type
number
 
transaction type


real_money
number
 
Indicates whether this is a real-money (fiat) transaction


deleted
number
 
whether the transaction was deleted


start_date
number
 
 Example:  start_date=20251201
period start date


end_date
number
 
 Example:  end_date=20251231
period end date


balance_is
number
 
 Example:  balance_is=1
0 - any balance, 1 - positive, 2 - negative


document_id
number
 
document ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Get Transactions by Visit or Appointment ID 
Transaction filtering


    

  • record_id: record ID
    

    • 

  • visit_id: ID of the visit
    

    • 



Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
record_id
number
 
Appointment ID


visit_id
number
 
Visit ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Create a Financial Transaction 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
expense_id
number
 
Payment item


amount
number <float> 
 
Transaction amount


account_id
number
 
Checkout ID


client_id
number
 
Client ID


supplier_id
number
 
Supplier ID


master_id
number
 
team member ID


comment
number
 
A comment


date
string <date-time> 
 
Transaction creation date


Responses
 Request samples 
Content type
application/json
{
  • "expense_id": 2640,
  • "amount": 100,
  • "account_id": 39105,
  • "client_id": 4240788,
  • "supplier_id": 0,
  • "master_id": 0,
  • "comment": "Test transaction comment",
  • "date": "2025-08-29T10:00:00+00:00"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Getting a financial transaction 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


transaction_id
required
number
 
transaction ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Financial Transaction Update 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


transaction_id
required
number
 
transaction ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
required
expense_id
number
 
Payment item


amount
number <float> 
 
Transaction amount


account_id
number
 
Checkout ID


client_id
number
 
Client ID


supplier_id
number
 
Supplier ID


master_id
number
 
team member ID


comment
number
 
A comment


date
string <date-time> 
 
Transaction creation date


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Deleting a transaction 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


transaction_id
required
number
 
transaction ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Get document financial transactions 
Authorizations:
(beareruser) 
path Parameters
document_id
required
number
 
Document ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Notifications
Send SMS, Email or other notifications to clients. Configure notification preferences and settings for users and notification types.


Send SMS to the list of clients 
The object for creating SMS mailing has the following fields:






Field
Type
Description





client_ids
array of numbers
Array of client IDs




text
string
SMS text message





Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
client_ids
Array of numbers
 
Array of client IDs


text
string
 
SMS text message


Responses
 Request samples 
Content type
application/json
{
  • "client_ids": [
    ],
  • "text": "Dear clients, we congratulate you on being our clients! You are very lucky!"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Send SMS campaigns to customers matching the filters 
The object for creating SMS mailing has the following fields:






Field
Type
Description





text
string
SMS text message





Client filtering


    

  • fullname:'Joh' (optional, string) - Name (part of name) to filter clients
    • 

  • phone:'7916' (optional, string) - Phone (part of the number) to filter clients
    • 

  • email:'test@' (optional, string) - Email (part) for client filtering
    • 

  • card:'5663rt' (optional, string) - Card (part) to filter customers by loyalty card number
    • 



Attention: If there are no filters, SMS mailing will go to the entire database!


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
fullname
string
 
 Example:  fullname='Joh'
Name (part of the name) for client filtering


phone
string
 
 Example:  phone='7916'
Phone (part of the number) for customer filtering


email
string
 
 Example:  email='test@'
Email (part) for customer filtering


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
text
string
 
SMS text message


Responses
 Request samples 
Content type
application/json
{
  • "text": "Dear clients, we congratulate you on being our clients! You are very lucky!"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Send Email newsletter according to the list of clients 
The object for creating an Email campaign has the following fields:






Field
Type
Description





client_ids
array of numbers
Array of client IDs




text
string
Text Email Message




subject
string
Email Subject





Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
client_ids
required
Array of numbers
 
Array of client IDs


subject
required
string
 
Email Subject


text
required
string
 
Email text


Responses
 Request samples 
Content type
application/json
{
  • "client_ids": [
    ],
  • "subject": "Important!",
  • "text": "Dear clients, we congratulate you on being our clients! You are very lucky!"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Send email campaigns for clients matching the filters 
The object for creating an Email campaign has the following fields:






Field
Type
Description





text
string
Text Email Message




subject
string
Email Subject





Client filtering


    

  • fullname:'Joh' (optional, string) - Name (part of name) to filter clients
    • 

  • phone:'7916' (optional, string) - Phone (part of the number) to filter clients
    • 

  • email:'test@' (optional, string) - Email (part) for client filtering
    • 

  • card:'5663rt' (optional, string) - Card (part) to filter customers by loyalty card number
    • 



Attention: If there are no filters, email distribution will go to the entire database!


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
fullname
string
 
 Example:  fullname='Joh'
Name (part of the name) for client filtering


phone
string
 
 Example:  phone='7916'
Phone (part of the number) for customer filtering


email
string
 
 Example:  email='test@'
Email (part) for customer filtering


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
subject
required
string
 
Email Subject


text
required
string
 
Email text


Responses
 Request samples 
Content type
application/json
{
  • "subject": "Important!",
  • "text": "Dear clients, we congratulate you on being our clients! You are very lucky!"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Getting Message Statuses 
Get message statuses






Number
Title





1
Delivered




2
Not delivered




4
Sent to phone




8
Transferred to the operator




16
Rejected by operator




52
Not 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 code
Http status code
Title
Description





5
400
ENTITY_VALIDATION_ERROR
The request body did not pass validation




10
400
FIELD_VALIDATION_ERROR
Parameter not validated




15
403
ACCESS_FORBIDDEN
The action is not available, the application does not have the required permissions.




20
401
INVALID_PARTNER_TOKEN
partner_token missing or invalid




30
404
RESOURCE_NOT_FOUND
The 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}


Authorizations:
bearer
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Request Body schema: application/json
required
 Array 
id
string
 
Identifier


status
number
 
Message status


payment_sum
number
 
Full message cost


currency_iso
string
 
Currency ISO


parts_amount
number
 
Amount of message's parts


Responses
 Request samples 
Content type
application/json
[
  • {
    }
]
 Response samples 
Content type
application/json
{
  • "success": true
}
Get notification settings in a location 
The method allows you to get notification settings in a location.


Authorizations:
(userbearer) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer bearer_token, USer user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get User Notification Settings 
The method allows you to get notification settings for a particular location user.


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


user_id
required
number
 
User ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer bearer_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Change User Push Notification Settings 
The method allows you to change the user's PUSH notification settings.
The type of notification to be changed (record_create_online_staff or record_create_online_admin, etc.) should be selected based on the type of notification specified by the user (mode: admin or mode: staff)


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


user_id
required
number
 
User ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer bearer_token, User user_token


Request Body schema: application/json
required
Array of objects
 
Array of objects


Responses
 Request samples 
Content type
application/json
{
  • "notification_types": [
    ]
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Online Booking Settings
Manage custom booking forms and their configurations for online appointment scheduling.


Get a list of booking widgets 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Create a Booking Widget 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Request Body schema: application/json
required
title
required
string
 
Name of the appointment widget


description
string
 Default:  ""
 
appointment widget description


is_default
boolean
 Default:  false
 
Default appointment widget flag


without_menu
boolean
 Default:  false
 
Step mode flag


service_step_default
number
 
Service ID


service_step_hide
boolean
 Default:  false
 
Service Hiding Flag


master_step_default
number
 
team member ID


master_step_hide
boolean
 Default:  false
 
team member hide flag


service_step_num
number
 
Service step sequence number


master_step_num
number
 
Sequence number of the wizard step


datetime_step_num
number
 
Sequence number of the date and time step


show_button
boolean
 Default:  true
 
Button visibility flag


button_position
string
 Default:  "bottom right"
 Enum: "bottom right" "bottom left" "top right" "top left " 
 
Button location on the page


form_position
string
 Default:  "right"
 Enum: "right" "left" 
 
Panel position on the page


button_color
string
 Default:  "#1c84c6"
 
Button color


button_animation
boolean
 Default:  true
 
Button animation enable flag


Responses
 Request samples 
Content type
application/json
{
  • "title": "string",
  • "description": "",
  • "is_default": false,
  • "without_menu": false,
  • "service_step_default": 0,
  • "service_step_hide": false,
  • "master_step_default": 0,
  • "master_step_hide": false,
  • "service_step_num": 0,
  • "master_step_num": 0,
  • "datetime_step_num": 0,
  • "show_button": true,
  • "button_position": "bottom right",
  • "form_position": "right",
  • "button_color": "#1c84c6",
  • "button_animation": true
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get a Booking Widget 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


form_id
required
number
 
appointment widget ID


header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Delete Booking Widget 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


form_id
required
number
 
appointment widget ID


header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Change Booking Widget 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


form_id
required
number
 
appointment widget ID


header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Request Body schema: application/json
required
title
required
string
 
Name of the appointment widget


description
required
string
 
appointment widget description


is_default
required
boolean
 
Default appointment widget flag


without_menu
required
boolean
 
Step mode flag


service_step_default
required
number
 
Service ID


service_step_hide
required
boolean
 
Service Hiding Flag


master_step_default
required
number
 
team member ID


master_step_hide
required
boolean
 
team member hide flag


service_step_num
required
number
 
Service step sequence number


master_step_num
required
number
 
Sequence number of the wizard step


datetime_step_num
required
number
 
Sequence number of the date and time step


show_button
required
boolean
 
Button Visibility Step


button_position
required
string
 Enum: "bottom right" "bottom left" "top right" "top left" 
 
Button location on the page


form_position
required
string
 Enum: "right" "left" 
 
Panel position on the page


button_color
required
string
 
Button color


button_animation
required
boolean
 
Button animation enable flag


Responses
 Request samples 
Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "is_default": true,
  • "without_menu": true,
  • "service_step_default": 0,
  • "service_step_hide": true,
  • "master_step_default": 0,
  • "master_step_hide": true,
  • "service_step_num": 0,
  • "master_step_num": 0,
  • "datetime_step_num": 0,
  • "show_button": true,
  • "button_position": "bottom right",
  • "form_position": "right",
  • "button_color": "string",
  • "button_animation": true
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Analytics & Reports
Business analytics and statistical reports for business intelligence.


Get key company metrics 
The method allows you to get the main indicators of the location for the selected period and compare with the previous period of the same duration


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
date_from
required
string <date> 
 
Start date of the analyzed period


date_to
required
string <date> 
 
End date of the analyzed period (included in the report)


team_member_id
integer
 
ID of the location team member whose work needs to be analyzed


position_id
integer
 
location position ID to analyze the work of all team members belonging to the same position


user_id
integer
 
The user ID of the location whose work you want to analyze


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
{
  • "data": {
    },
  • "meta": [
    ],
  • "success": true
}
Get occupancy data by day 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
date_from
required
string <date> 
 
Start date of the analyzed period


date_to
required
string <date> 
 
End date of the analyzed period (included in the report)


team_member_id
integer
 
ID of the location team member whose work needs to be analyzed


user_id
integer
 
The user ID of the location whose work you want to analyze


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
[
  • {
    }
]
Get data on revenue by day 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
date_from
required
string <date> 
 
Start date of the analyzed period


date_to
required
string <date> 
 
End date of the analyzed period (included in the report)


team_member_id
integer
 
ID of the location team member whose work needs to be analyzed


position_id
integer
 
location position ID to analyze the work of all team members belonging to the same position


user_id
integer
 
The user ID of the location whose work you want to analyze


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
[
  • {
    }
]
Get the Structure of Appointments by Source 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
date_from
required
string <date> 
 
Start date of the analyzed period


date_to
required
string <date> 
 
End date of the analyzed period (included in the report)


team_member_id
integer
 
ID of the location team member whose work needs to be analyzed


user_id
integer
 
The user ID of the location whose work you want to analyze


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
[
  • {
    },
  • {
    }
]
Get the Structure of Appointments by Visit Status 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
date_from
required
string <date> 
 
Start date of the analyzed period


date_to
required
string <date> 
 
End date of the analyzed period (included in the report)


team_member_id
integer
 
ID of the location team member whose work needs to be analyzed


user_id
integer
 
The user ID of the location whose work you want to analyze


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]
Get Data on the Number of Appointments by Day 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
date_from
required
string <date> 
 
Start date of the analyzed period


date_to
required
string <date> 
 
End date of the analyzed period (included in the report)


team_member_id
integer
 
ID of the location team member whose work needs to be analyzed


user_id
integer
 
User ID of the location whose work you want to analyze


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]
Get revenue statistics 
The method allows you to get statistics on revenue.


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
date_to
required
string
 
Period end date


date_from
required
string
 
Period start date


loyalty_program_id
required
string
 
Promotion ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer bearer_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get employee return 
The method allows you to get the return statistics for a team member


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
date_to
required
string
 
Period end date


date_from
required
string
 
Period start date


loyalty_program_id
required
string
 
Promotion ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer bearer_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get customer statistics 
The method allows you to get statistics on returning, new and lost customers


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
date_to
required
string
 
Period end date


date_from
required
string
 
Period start date


loyalty_program_id
required
string
 
Promotion ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer bearer_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get day-end report data 
    

  • start_date: Report date
    

    • 

  • master_id: team member ID
    

    • 



Authorizations:
(beareruser) 
path Parameters
location_id
required
integer
 
location ID


query Parameters
start_date
string
 
 Example:  start_date=''
period start date


master_id
integer
 
team member ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Categories & Labels
Custom labels and categorization for clients, appointments, and events.


Create a Category 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
title
required
string
 
name of category


color
required
string
 
Label color in #RRGGBB format


entity
number
 
Category object (0 - general tags, 1 - customer tags, 2 - appointment tags)


icon
string
 
Icon name


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get company categories 
Returns categories for the specified entity type.


The entity parameter accepts string aliases:


    

  • common - common categories
    • 

  • client - client categories
    • 

  • record - appointment/record categories
    • 

  • activity - activity/event categories
    • 





Legacy support: Numeric values (0, 1, 2, 3) are also accepted but string aliases are preferred.




Authorizations:
(beareruser) 
path Parameters
location_id
required
integer
 
Location ID


entity
required
string
 Enum: "common" "client" "record" "activity" 
 
 Example:  client
Category type alias


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Update Category 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


label_id
required
number
 
Tag ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
title
string
 
name of category


color
string
 
Label color in #RRGGBB format


entity
number
 
Category object (1 - category for customers, 2 - category for appointments)


icon
string
 
Icon name


Responses
 Request samples 
Content type
application/json
{
  • "title": "Testway2",
  • "color": "#aa11ff",
  • "entity": 2,
  • "icon": "Test"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Delete company category 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


label_id
required
number
 
Tag ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Get Customer Categories Searchable by Name 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Create a client company category 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
required
title
string
 
name of category


color
string
 
Label color in #RRGGBB format


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Deposits
Client deposit account management and operations.


Get a List of Client Personal Accounts by Location and Client 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


client_id
required
number
 
Client ID


header Parameters
Accept
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Getting a list of personal accounts by chain and a set of filters 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
number
 
Chain ID


query Parameters
balance_from
number
 
Minimum balance for filtering


balance_to
number
 
Maximum balance for filtering


page
number
 
Page number


limit
number
 
Number of items per page


header Parameters
Accept
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Getting a list of personal accounts by chain and customer phone number 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
number
 
Chain ID


phone
required
number
 
Customer phone number


header Parameters
Accept
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Creation of a client personal account topup operation 
Creating a transaction with a personal account involves creating a document, a transaction with a personal account, and a financial transaction within a single API request.


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
optional
client_id
required
number
 
ID of the client, the owner of the client personal account


deposit_id
required
number
 
personal account ID


amount
required
number
 
replenishment amount


master_id
number
 
team member ID


account_id
required
number
 
Checkout ID for payment


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Loyalty Cards
Loyalty card management including card types, manual transactions, and card assignments.


Get a List of Customer Cards by ID 
Returns a list of customer cards with programs that are active in this location


The attributes in the response to the request completely match the "Get a list of issued cards by phone number" method described above


Authorizations:
(beareruser) 
path Parameters
client_id
required
number
 
Client ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "id": 9210520,
  • "balance": 100,
  • "points": 0,
  • "paid_amount": 1000,
  • "sold_amount": 1000,
  • "visits_count": 1,
  • "number": 14507109210520,
  • "type_id": 10992,
  • "salon_group_id": 145071,
  • "type": {
    },
  • "salon_group": {
    },
  • "programs": [
    ]
}
Get a List of Customer Cards by Phone Number 
Returns a list of customer cards with programs that are active in this location






Attribute
Type
Description





id
int
Loyalty card ID




balance
decimal
Loyalty card balance




paid_amount
decimal
Amount "Paid"




sold_amount
decimal
Amount "Sold"




visits_count
int
Number of visits




number
string
Card number




type_id
int
Loyalty card type identifier




salon_group_id
int
ID of the chain where the card was created




type
object
Object that contains the "id" and "title" fields: card type identifier and name




salon_group
object
Object that contains the "id" and "title" fields: identifier of the chain where the card type was created and the name of this chain




programs
array
Array with information about promotions linked to a loyalty card




rules
array
Array with information about the rules configured in the action





The programs array consists of objects with the following fields:






Attribute
Type
Description





id
int
Promotion ID




title
string
Action name




loyalty_type_id
int
Promotion type ID




item_type_id
int
Is cashback accrued from products




value_unit_id
int
Bonus field — Discount % or Fixed amount




group_id
int
ID of the chain where the action was created




loyalty_type
object
Object with information about the action





The rules array consists of objects with the following fields:






Attribute
Type
Description





id
int
Rule ID




loyalty_program_id
int
Identifier of the promotion to which the rule is attached




loyalty_type_id
int
Promotion type ID




value
decimal
Value from which the rule will work





Authorizations:
(beareruser) 
path Parameters
phone
required
string
 
Customer phone number in the format 380000000000


chain_id
required
number
 
Chain ID


location_id
required
number
 
Location ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "id": 9210520,
  • "balance": 100,
  • "points": 0,
  • "paid_amount": 1000,
  • "sold_amount": 1000,
  • "visits_count": 1,
  • "number": 14507109210520,
  • "type_id": 10992,
  • "salon_group_id": 145071,
  • "type": {
    },
  • "salon_group": {
    },
  • "programs": [
    ]
}
Get User Loyalty Cards 
Returns a list of cards of an authorized user with programs, filtering cards by location chain / location


Authorizations:
(beareruser) 
path Parameters
chain_id
required
number
 
Chain ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "id": 9210520,
  • "balance": 100,
  • "points": 0,
  • "paid_amount": 1000,
  • "sold_amount": 1000,
  • "visits_count": 1,
  • "number": 14507109210520,
  • "type_id": 10992,
  • "salon_group_id": 145071,
  • "type": {
    },
  • "salon_group": {
    },
  • "programs": [
    ]
}
Get a list of card types available at the location 
Returns a list of card types that are valid for the given location.


The attributes and their descriptions match those defined in the "Collection of Card Types Available to the Client" method described above.


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
 Example:  12345
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
[
  • {
    },
  • {
    }
]
Get a List of Card Types Available for Issuance to the Client 
Returns a list of card types that are available for issuance to a location client.






Attribute
Type
Description





id
int
Card type identifier




title
string
Card type name




salon_group_id
int
ID of the chain where the card type was created




salon_group
object
An object that contains the "id" and "title" fields: identifier of the chain where the card type was created and the name of this chain





Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
 Example:  12345
location ID


phone
required
number
 
 Example:  70001234567
Customer phone number


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
[
  • {
    },
  • {
    }
]
Get a List of Card Types Available at the Chain 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
integer
 
Chain ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
[
  • {
    }
]
Issue a Loyalty Card 
| Attribute | Type | Description |
|----------------------|--------|----------------- ------------------------------|
| loyalty_card_number | number | Loyalty card number |
| loyalty_card_type_id | number | Loyalty card type identifier |
| phone | number | Customer phone number in the format 70001234567 |


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
loyalty_card_number
string
 
Loyalty card number


loyalty_card_type_id
string
 
Loyalty card type identifier


phone
number
 
Customer phone number in the format 70001234567


Responses
 Request samples 
Content type
application/json
{
  • "loyalty_card_number": "9090909",
  • "loyalty_card_type_id": "8230",
  • "phone": "79091552422"
}
 Response samples 
Content type
application/json
{
  • "id": 9250498,
  • "balance": 0,
  • "points": 0,
  • "paid_amount": 16300,
  • "sold_amount": 19320,
  • "visits_count": 5,
  • "number": 1010101,
  • "type_id": 8230,
  • "salon_group_id": 145071,
  • "type": {
    },
  • "salon_group": {
    },
  • "programs": [
    ]
}
Remove a Loyalty Card 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


card_id
required
number
 
loyalty card ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Manual withdraw/deposit to loyalty card in company 
Manual withdraw/deposit to loyalty card in location


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


card_id
required
number
 
Loyalty card ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Request Body schema: application/json
amount
required
number
 
Withdraw/deposit amount. Positive for deposit, negative for withdraw.


title
string
 
Optional comment


Responses
 Request samples 
Content type
application/json
{
  • "amount": 100.5,
  • "title": "string"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}
Manual withdraw/deposit to loyalty card in chain 
Manual withdraw/deposit to loyalty card in chain


Authorizations:
BearerPartnerUser
path Parameters
chain_id
required
number
 
 Example:  123
ID of a chain.


card_id
required
number
 
Loyalty card ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Request Body schema: application/json
amount
required
number
 
Withdraw/deposit amount. Positive for deposit, negative for withdraw.


title
string
 
Optional comment


Responses
 Request samples 
Content type
application/json
{
  • "amount": 100.5,
  • "title": "string"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}
Subscriptions & Certificates
Abonement (subscription) and certificate management including creation, freezing, and balance operations.


Get Client Memberships 
Returns a list of client's memberships by phone


Authorizations:
(beareruser) 
query Parameters
company_id
required
number
 
Location ID


phone
required
number
 
Customer phone number


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get User Memberships 
Returns a list of memberships of an authorized user


Authorizations:
(beareruser) 
query Parameters
company_id
required
number
 
Location ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get a List of Membership Types by ID 
A list of membership types available at a location can be obtained by querying the location ID and membership type IDs.


The list is an array of membership types.


Get a list of subscription types by ID


    

  • Parameters
      

    • company_id (required, number) - company ID
      • 

    • id: 1 (optional, number) - membership type ID (you can specify several additional parameters &ids[]={id}
      • 

    

    • 



Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
ids[]
number
 
Membership type ID (you can specify several additional parameters &ids[]={id}


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get a List of Available Membership Types 
A list of membership types available at a location can be obtained by requesting the location ID.
The list can be filtered by membership type name by passing the title parameter. Pagination is supported, specified by the page and page_size parameters.


The list is an array of membership types.



Membership type has the following structure:






Field
Type
Description





id
number
Membership type identifier




title
string
Membership type name




allow_freeze
boolean
Is it possible to freeze memberships? true - allowed, false - not allowed




freeze limit
number
Maximum total freezing period (days)




salon_group_id
number
Identifier of the chain in which the membership type is valid




period
number
Membership expiration date (0 if not set)




period_unit_id
number
Membership expiration unit (list of possible values, if not set - 0)




is_allow_empty_code
boolean
Allow the sale of a membership without a code? true - allow, false - do not allow




is_united_balance
boolean
Total or separate membership balance: true - total, false - separate




united_balance_services_count
number
Number of visits for total balance






Measurement units of subscription type validity period






Meaning
Description





1
Day




2
Week




3
Month




4
Year





Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
title
string
 
Membeship type name


page
number
 
Page number


page_size
number
 
The number of output lines per page. Maximum 100


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Conetnt-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get a List of Memberships by Filter 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
number
 
 Example:  123
Chain ID.


query Parameters
created_after
string
 
 Example:  created_after=2025-09-21T23:00:00.000+03:00
Creation date from (filter by creation date).


created_before
string
 
 Example:  created_before=2025-09-21T23:00:00.000+03:00
Creation date by (filter by creation date).


abonements_ids
Array of numbers
 
List of identifiers for the filter.


page
number
 
 Example:  page=1
Page number.


count
number
 
 Example:  count=25
Number of appointments per page.


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
[
  • {
    }
]
Search available subscriptions for activity 
Retrieves subscriptions that can be used to create a client schedule for a series of events.


This method returns subscriptions (abonements) that:


    

  • Belong to the specified client
    • 

  • Are valid and active
    • 

  • Can be applied to the specified activity
    • 

  • Have remaining visits available
    • 



Use cases:


    

  • Display available subscriptions when booking recurring activity sessions
    • 

  • Check which subscriptions cover specific activity types
    • 

  • Validate subscription applicability before creating schedules
    • 



Note: Returns subscriptions with their types and availability intervals.


Authorizations:
bearer
path Parameters
location_id
required
integer
 
 Example:  720441
Location ID


client_id
required
integer
 
 Example:  146915197
Client ID


query Parameters
activity_id
required
integer
 
 Example:  activity_id=12345
Activity (group event) ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Responses
 Response samples 
Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ]
}
Check subscription availability for activity 
Validates a specific subscription for creating activity schedules.


Returns:


    

  • Last possible booking date based on subscription expiration
    • 

  • Available visit count for the selected subscription
    • 

  • Schedule day IDs that can be booked
    • 



Use cases:


    

  • Validate subscription before creating recurring bookings
    • 

  • Check if subscription has enough visits for schedule
    • 

  • Determine last bookable date based on expiration
    • 

  • Pre-validate schedule parameters
    • 



Note: Requires schedule_day_ids parameter to check specific dates.


Authorizations:
bearer
path Parameters
location_id
required
integer
 
 Example:  720441
Location ID


client_id
required
integer
 
 Example:  146915197
Client ID


abonement_id
required
integer
 
 Example:  5248829
Subscription instance ID


query Parameters
activity_id
required
integer
 
 Example:  activity_id=12345
Activity (group event) ID


schedule_day_ids
required
string
 
 Example:  schedule_day_ids=1,2,3,4,5
Comma-separated list of schedule day IDs to check


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Responses
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
Get client gift cards 
Returns a list of client gift cards by phone






Attribute
Type
Description





id
int
Gift card ID




number
string
Gift card code




balance
decimal
Current balance




default_balance
decimal
Initial balance




type_id
int
Gift card type identifier




status_id
int
Status ID




created_date
timestamp
Date of sale




expiration_date
datetime
Burn date




type
object
Object with gift card type information




status
object
An object with information about the current gift card status





The type array contains the following objects:






Attribute
Type
Description





id
int
Gift card type identifier




title
string
Type name




balance
decimal
Gift card denomination




is_multi
boolean
Is it available for multiple debits




company_group_id
int
ID of the chain where the certificate type was created




item_type_id
int
Restriction on the use of redemption points. 0 - no limit, 1 - services only, 2 - some services + all products, 3 - some services, 4 - products only




expiration_type_id
int
The ID of the expiration limit. 0 - unlimited, 1 - fixed date, 2 - fixed term




expiration_date
timestamp
Burn date of all gift cards. Populated with expiration_type_id = 1




expiration_timeout
int
Validity period of gift card. Populated with expiration_type_id = 2




expiration_timeout_unit_id
int
Time units. 1 - Day, 2 - Week, 3 - Month, 4 - Year




is_allow_empty_code
boolean
Sale without code




item_type
object
Object with item_type_id and its name





Authorizations:
(beareruser) 
query Parameters
copmany_id
required
number
 
Location ID


phone
required
number
 
Customer phone number


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get user gift cards 
Returns a list of authorized user gift cards


Authorizations:
(beareruser) 
query Parameters
company_id
required
number
 
Location ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get a List of Gift Card Types by ID 
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.


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get a List of Available Gift Card Types 
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:






Field
Type
Description





id
number
Gift card type identifier




title
string
Gift card type name




balance
number
Gift card denomination




is_multi
boolean
Write-off type: true - multiple write-off, false - single write-off




company_group_id
number
ID of the chain where the gift card type is valid




item_type_id
number
Application Constraint (list of possible values)




expiration_type_id
number
Expiration limit (list of possible values)




expiration_date
string
Fixed burn date in ISO8601 format (null if not set)




expiration_timeout
number
Gift card validity period from the date of sale (0 if not set)




expiration_timeout_unit_id
number
The 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_code
boolean
Allow sale of gift card without code? true - allow, false - do not allow






Gift Card Type Restriction






Meaning
Description





0
Unlimited




1
Any services without products




2
Any products without services




3
Some services without products




4
Some services and any products






Gift Card Type Expiration Limit






Meaning
Description





0
No expiration date




1
Fixed date for all instances




2
Fixed period of validity from the date of sale






Units of certificate type validity period






Meaning
Description





1
Day




2
Week




3
Month




4
Year





Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
title
string
 
Gift card type name


page
number
 
Page number


page_size
number
 
The number of output lines per page. Maximum 100


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
integer
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Loyalty Programs
Loyalty programs and loyalty transaction management.


Get a List of Promotions Active in the Location 
The method allows you to get a list of promotions that are active for the specified location.


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
include
string
 
The first_transaction_date value adds the date of the first stock transaction to the response.


type
string
 Enum: "discount_static" "discount_accumulative_visits" "discount_accumulative_sold" "discount_accumulative_paid" "cashback_static_sold" "cashback_static_paid" "cashback_accumulative_paid" "cashback_accumulative_sold" "cashback_accumulative_paid_visits" "cashback_accumulative_sold_visits" "cashback_sold_visits" "cashback_paid_visits" "package_discount" 
 
Promotion type


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer bearer_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get loyalty transactions by visit 
List of transactions for loyalty promotions for this visit


Authorizations:
(beareruser) 
path Parameters
visit_id
required
number
 
Visit ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
[
  • {
    },
  • {
    }
]
Gift Card/Membership Code Generation 
    

  • Options
      

    • salonId (required, number, 1) - location ID
      • 

    • goodId (required, number, 1) - product ID (gift card/ membership)
      • 

    

    • 



Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


good_id
required
number
 
Product ID (membership/gift card)


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Apply Deduction from the Loyalty Card in the Visit 
The amount deducted will not exceed the available bonus balance. If the value is set to 0, no write-off transaction will occur


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


card_id
required
number
 
Client card ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
required
record_id
required
number
 
Appointment ID


visit_id
required
number
 
Visit ID


amount
required
number
 
Number of points to redeem


Responses
 Response samples 
Content type
application/json
{
  • "payment_transactions": [ ],
  • "loyalty_transactions": [
    ],
  • "kkm_transaction_details_container": {
    },
  • "items": [
    ]
}
Cancel Withdrawal from the Loyalty Card During the Visit 
Cancellation of write-off from the loyalty card.


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


card_id
required
number
 
Client card ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
required
record_id
required
number
 
Appointment ID


visit_id
required
number
 
Visit ID


Responses
 Response samples 
Content type
application/json
{
  • "payment_transactions": [ ],
  • "loyalty_transactions": [ ],
  • "kkm_transaction_details_container": {
    },
  • "items": [
    ]
}
Apply a Discount Promotion in a Visit 
Applying a promotion to a visit, it only makes sense if there is a visit


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


card_id
required
number
 
Client card ID


program_id
required
number
 
ID of the promotion linked to the card


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
record_id
required
number
 
Appointment ID


visit_id
required
number
 
Visit ID


Responses
 Request samples 
Content type
application/json
{
  • "record_id": 0,
  • "visit_id": 0
}
 Response samples 
Content type
application/json
{
  • "payment_transactions": [ ],
  • "loyalty_transactions": [
    ],
  • "kkm_transaction_details_container": {
    },
  • "items": [
    ]
}
Cancel the Application of the Discount Promotion in the Visit 
Cancellation of the promotion applied to the visit.


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


card_id
required
number
 
Client card ID


program_id
required
number
 
ID of the promotion linked to the card


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
required
record_id
required
number
 
Appointment ID


visit_id
required
number
 
Visit ID


Responses
 Response samples 
Content type
application/json
{
  • "payment_transactions": [ ],
  • "loyalty_transactions": [ ],
  • "kkm_transaction_details_container": {
    },
  • "items": [
    ]
}
Apply Referral Program During a Visit 
Applying a referral program to a visit


Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


chain_id
required
number
 
ID of the chain where the referral program is configured


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
required
record_id
required
number
 
Appointment ID


visit_id
required
number
 
Visit ID


referrer_phone
required
number
 
Phone number of the inviter


Responses
 Response samples 
Content type
application/json
{
  • "payment_transactions": [ ],
  • "loyalty_transactions": [
    ],
  • "kkm_transaction_details_container": {
    },
  • "items": [
    ]
}
Retrieve company subscription information 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Salary
Salary calculations, payroll management, and compensation tracking for team members.


Receipt of mutual settlements of an employee grouped by date 
The method allows location owner to get mutual settlements of a team member grouped by date.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


team_member_id
required
integer
 
 Example:  123
ID of a team member.


query Parameters
date_from
required
string
 
 Example:  date_from=2023-03-01
Start from date.


date_to
required
string
 
 Example:  date_to=2023-03-31
End to date.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": {
    }
}
Receipt of mutual settlements of an employee 
The method allows location owner to get mutual settlements of a team member.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


team_member_id
required
integer
 
 Example:  123
ID of a team member.


query Parameters
date_from
required
string
 
 Example:  date_from=2023-03-01
Start from date.


date_to
required
string
 
 Example:  date_to=2023-03-31
End to date.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Obtaining payroll schemes count for an employee 
The method allows you to get salary calculation schemes count for a team member before trying to obtain calculation data.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


team_member_id
required
integer
 
 Example:  123
ID of a team member.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Search payroll calculations of an employee 
The method allows location owner to search payroll calculations for the period for a team member.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


team_member_id
required
integer
 
 Example:  123
ID of a team member.


query Parameters
date_from
required
string
 
 Example:  date_from=2023-03-01
Start from date.


date_to
required
string
 
 Example:  date_to=2023-03-31
End to date.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get payroll calculation details of an employee 
The method allows location owner to get details of a specific payroll calculation.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


team_member_id
required
integer
 
 Example:  123
ID of a team member.


calculation_id
required
number
 
 Example:  789
ID of a salary calculation.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Getting payroll for a period for an employee grouped by date 
The method allows location owner to get the calculation for the period for a team member grouped by date.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


team_member_id
required
integer
 
 Example:  123
ID of a team member.


query Parameters
date_from
required
string
 
 Example:  date_from=2023-03-01
Start from date.


date_to
required
string
 
 Example:  date_to=2023-03-31
End to date.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": {
    }
}
Getting payroll for a period for an employee 
The method allows location owner to get the calculation for the period for a team member.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


team_member_id
required
integer
 
 Example:  123
ID of a team member.


query Parameters
date_from
required
string
 
 Example:  date_from=2023-03-01
Start from date.


date_to
required
string
 
 Example:  date_to=2023-03-31
End to date.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get Mutual Settlements for a Specific Team Member 
The method allows you to get mutual settlements of a specific team member. In the user's access rights, the checkbox "Access to payroll only for a specific team member" must be specified.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


team_member_id
required
integer
 
 Example:  123
ID of a team member.


query Parameters
date_from
required
string
 
 Example:  date_from=2023-03-01
Start from date.


date_to
required
string
 
 Example:  date_to=2023-03-31
End to date.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get Payroll for a Specific Team Member for a Given Period 
The method allows you to get the calculation for the period for a specific team member.
In the user's access rights, the checkbox "Access to payroll only for a specific team member" must be checked.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


team_member_id
required
integer
 
 Example:  123
ID of a team member.


query Parameters
date_from
required
string
 
 Example:  date_from=2023-03-01
Start from date.


date_to
required
string
 
 Example:  date_to=2023-03-31
End to date.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Obtaining own payroll schemes for a specific employee 
The method allows you to get own salary calculation schemes for a specific team member.
In the user's access rights, the checkbox "Access to payroll only for a specific team member" must be specified.


Authorizations:
BearerPartnerUser
path Parameters
location_id
required
number
 
 Example:  123
ID of a location.


team_member_id
required
integer
 
 Example:  123
ID of a team member.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Custom Fields
Additional custom field definitions for extending entity data structures.


Getting a collection of location fields 
Authorizations:
(beareruser) 
path Parameters
field_category
required
string
 
 Example:  record
Field category.


    

  • For appointments - appointment
    

    • 

  • For clients - client 
    

    • 



location_id
required
integer
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Adding an Additional Field 
To add a field, the user must be part of the Chain associated with the location and have the appropriate access rights in the following section: 
Settings → Access → Additional Fields → Create additional fields


Authorizations:
(beareruser) 
path Parameters
field_category
required
string
 
 Example:  record
Field category.


    

  • For appointments - appointment
    

    • 

  • For clients - client 
    

    • 



location_id
required
integer
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
type
required
string
 
Field type


code
required
string
 
Field ID


title
required
string
 
Field name


user_can_edit
required
boolean
 
Can the user edit the field


show_in_ui
required
boolean
 
Whether to show the field in the interface


Responses
 Request samples 
Content type
application/json
{
  • "type": "text",
  • "code": "my_text_field",
  • "title": "test field",
  • "user_can_edit": true,
  • "show_in_ui": true
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Update an Additional Field 
To update a field, the user must be part of the Chain associated with the location and have the appropriate access rights in the following section 
Settings → Access → Additional Fields → Modify additional fields


Authorizations:
(beareruser) 
path Parameters
field_category
required
string
 
 Example:  record
Field category.


    

  • For appointments - appointment
    

    • 

  • For clients - client 
    

    • 



location_id
required
integer
 
location ID


field_id
required
integer
 
field ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
type
required
string
 
Field type


code
required
string
 
Field ID


title
required
string
 
Field name


user_can_edit
required
boolean
 
Can the user edit the field


show_in_ui
required
boolean
 
Whether to show the field in the interface


Responses
 Request samples 
Content type
application/json
{
  • "type": "text",
  • "code": "my_text_field",
  • "title": "test field",
  • "user_can_edit": true,
  • "show_in_ui": true
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": {
    }
}
Remove an Additional Field from a Location 
To remove a field, the user must be part of the Chain associated with the location and have the appropriate access rights in the following section: 
Settings → Access → Additional Fields → Remove additional fields


Authorizations:
(beareruser) 
path Parameters
field_category
required
string
 
 Example:  record
Field category.


    

  • For appointments - appointment
    

    • 

  • For clients - client 
    

    • 



location_id
required
integer
 
location ID


field_id
required
integer
 
field ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": {
    }
}
VoIP Integration
Telephony integration for managing phone calls and call history within Altegio.


Telephony events 
Enable integration


To use the api and activate access to the settings in the user interface, you need to activate the integration by sending the "Enable integration" request. After a successful connection, access to the section with routing settings will be opened in the chain user interface.


Disable integration


To disable the integration, you can use the "Disable integration" method. After the integration is disabled, access to the user interface settings section is closed, the requests "Call notification" and "Call information saving" are not processed.


Call notification


To display notifications about an incoming call, the "Call notification" method is used, the call type ("incoming", "outgoing", "internal") is specified in the parameters, but currently notifications are displayed only for the "incoming" value. Notifications are displayed for users defined based on routing settings. When specifying the "user" and "diversion" parameters at the same time, "user" is the priority when searching for routes.


Saving call information


The information about the call is automatically saved to the chain history and to the history of chain locations in accordance with the call routing settings.


Authorizations:
bearer
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Request Body schema: application/json
required
Request bodies


 Any of 
command
required
string
 
Slug of operation 'setup'


type
required
string
 
Operation type, in this case 'enable'


crm_token
required
string
 
CRM-token from the Telephony-Integration in the client's chain section


Responses
 Request samples 
Content type
application/json
Example
{
  • "command": "setup",
  • "type": "enable",
  • "crm_token": "7cf262d6-1656-43f9-86ac-2826bdc125d2"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Get Location's Call List 
This endpoint is designed to get a list of calls in a location, taking into account filters and pagination


Authorizations:
BearerPartnerUser
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Request Body schema: application/json
salon_id
required
number
 
Location ID.


date_from
required
string
 
Sample start date.


date_to
required
string
 
Sample start end.


phone
string
 
Phone number.


types
Array of strings
Items Enum: "incoming" "outgoing" "internal" 
 
Call types list


statuses
Array of strings
Items Enum: "success" "missed" "cancel" "busy" "notallowed" "notavailable" "notfound" 
 
Call statuses list


page
number
 
Page number


limit
number  <= 1000 
 
Amount of elements on page


Responses
 Request samples 
Content type
application/json
{
  • "salon_id": 615243,
  • "date_from": "2023-01-01",
  • "date_to": "2023-02-01",
  • "phone": 79111234567,
  • "types": [
    ],
  • "statuses": [
    ],
  • "page": 1,
  • "limit": 25
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}
Chain Management
Chain-level operations for managing multiple locations within a business chain.


Obtaining chains available to the user 
The location chain object has the following fields:






Field
Type
Description





id
number
Location chain ID




title
string
Location chain name




locations
array
List of chain locations




access
object
Object with access rights for chain management





Authorizations:
(beareruser) 
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}
Get a chain client by phone number. 
    

  • Parameter
      

    • group_id (required, number, 43877) - ID of the location chain
      • 

    

    • 



Client filtering


    

  • phone:'70001234567' (optional, string) - Phone to filter clients
    • 



Authorizations:
(beareruser) 
path Parameters
chain_id
required
number
 
Chain ID


query Parameters
phone
required
string
 
 Example:  phone=14264037640
Phone to filter clients, required parameter


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token.User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Chain Loyalty Programs
Chain-level loyalty program management including programs, transactions, and message templates.


List subscription types 
Retrieves all subscription types available in the chain.


Note: Requires chain-level permissions.


Authorizations:
bearer
path Parameters
chain_id
required
integer
 
 Example:  706028
Chain ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Create subscription type 
Creates a new subscription type at the chain level. Subscription types define reusable packages
(e.g., "10 visits", "Monthly unlimited") that can be sold across multiple locations in the chain.


Important API Differences:


    

  • services and service_categories must be objects (key-value pairs), not arrays
    • 

  • Example: {"service_id": count} not [service_id]
    • 

  • The YClients documentation shows arrays, but the real API requires objects
    • 



Note: Requires chain-level permissions.


Authorizations:
bearer
path Parameters
chain_id
required
integer
 
 Example:  1
Chain ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Request Body schema: application/json
required
title
required
string
 
Subscription type name


salon_group_id
required
integer
 
Chain ID (API uses salon_group_id parameter name)


cost
required
number <float> 
 
Subscription price


location_ids
Array of integers
 
List of location IDs where this subscription type is available


period
integer
 
Validity period duration


period_unit_id
integer
 Enum: 1 2 3 4 
 
Period unit type: 1 = day, 2 = week, 3 = month, 4 = year


allow_freeze
boolean
 Default:  false
 
Whether subscription can be frozen


freeze_limit
integer
 
Maximum total freeze period


freeze_limit_unit_id
integer
 Enum: 1 2 3 4 
 
Freeze period unit: 1 = day, 2 = week, 3 = month, 4 = year


service_price_correction
boolean
 Default:  false
 
Whether service price can be adjusted when using subscription


expiration_type_id
integer
 Enum: 1 2 3 
 
Activation type: 1 = on sale, 2 = on first use, 3 = from specific date


is_allow_empty_code
boolean
 Default:  true
 
Personal vs shared subscription.


    

  • true = personal (only purchaser can use)
    • 

  • false = shared (multiple people can use with code)
    • 



is_united_balance
required
boolean
 
Balance type: true = unified balance, false = separate balance


united_balance_services_count
required
integer
 
Number of visits for unified balance


balance_edit_type_id
integer
 Enum: 0 1 2 
 
Balance adjustment permission: 0 = prohibited, 1 = only at sale location, 2 = at all locations


is_online_sale_enabled
boolean
 Default:  false
 
Whether online sale is enabled.
If true, online_sale_price becomes required.


online_sale_title
string
 
Subscription title for online sale


online_sale_description
string
 
Subscription description for online sale


online_sale_price
number <float> 
 
Price for online sale (required if is_online_sale_enabled = true)


online_image
string
 
Image URL for online sale


autoactivation_period
integer
 
Maximum autoactivation period


autoactivation_time_in_days
integer
 
Time units for autoactivation


autoactivation_time_unit_id
integer
 Enum: 1 2 3 4 
 
Autoactivation time unit: 1 = days, 2 = weeks, 3 = months, 4 = years


is_archived
boolean
 Default:  false
 
Whether subscription type is archived


category
string
 Default:  "standard"
 
Subscription category type (always "standard")


salon_ids
Array of integers
 
List of location IDs where this subscription type is available


object
 
Object with service IDs as keys and usage count as values.
For separate balance: count = number of visits per service.
For unified balance: use empty object {}.


Important: This is an object (key-value pairs), NOT an array.


required
object
 
Object with service category IDs as keys and usage count as values.
For separate balance: count = number of visits per category.
For unified balance: count value is ignored (set to any number or 0).


Important: This is an object (key-value pairs), NOT an array.


delete_online_image
boolean
 Default:  false
 
Whether to delete existing online sale image


Array of objects
 
Time-based availability rules. Empty array = available anytime.


Responses
 Request samples 
Content type
application/json
{
  • "title": "Fitness 10-pack",
  • "salon_group_id": 1,
  • "cost": 500,
  • "location_ids": [
    ],
  • "period": 30,
  • "period_unit_id": 3,
  • "allow_freeze": true,
  • "freeze_limit": 14,
  • "freeze_limit_unit_id": 1,
  • "service_price_correction": true,
  • "expiration_type_id": 1,
  • "is_allow_empty_code": true,
  • "is_united_balance": false,
  • "united_balance_services_count": 10,
  • "balance_edit_type_id": 2,
  • "is_online_sale_enabled": false,
  • "online_sale_title": "Fitness Pack - 10 sessions",
  • "online_sale_description": "Perfect for beginners. Valid for 3 months.",
  • "online_sale_price": 450,
  • "online_image": "https://example.com/images/fitness-pack.jpg",
  • "autoactivation_period": 3,
  • "autoactivation_time_in_days": 10,
  • "autoactivation_time_unit_id": 1,
  • "is_archived": false,
  • "category": "standard",
  • "salon_ids": [
    ],
  • "services": {
    },
  • "service_categories": {
    },
  • "delete_online_image": false,
  • "availability": [
    ]
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get subscription type details 
Retrieves detailed information about a specific subscription type.


Note: Requires chain-level permissions.


Authorizations:
bearer
path Parameters
chain_id
required
integer
 
 Example:  1
Chain ID


loyalty_abonement_type_id
required
integer
 
 Example:  468039
Subscription type ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Update subscription type 
Updates an existing subscription type. You can update basic information
(title, cost, period) without modifying the service/category links.


Note: To preserve existing services, pass empty arrays for
services and service_categories fields.


Authorizations:
bearer
path Parameters
chain_id
required
integer
 
 Example:  1
Chain ID


loyalty_abonement_type_id
required
integer
 
 Example:  468039
Subscription type ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Request Body schema: application/json
required
title
required
string
 
Subscription type name


salon_group_id
required
integer
 
Chain ID (API uses salon_group_id parameter name)


cost
required
number <float> 
 
Subscription price


location_ids
Array of integers
 
List of location IDs where this subscription type is available


period
integer
 
Validity period duration


period_unit_id
integer
 Enum: 1 2 3 4 
 
Period unit type: 1 = day, 2 = week, 3 = month, 4 = year


allow_freeze
boolean
 Default:  false
 
Whether subscription can be frozen


freeze_limit
integer
 
Maximum total freeze period


freeze_limit_unit_id
integer
 Enum: 1 2 3 4 
 
Freeze period unit: 1 = day, 2 = week, 3 = month, 4 = year


service_price_correction
boolean
 Default:  false
 
Whether service price can be adjusted when using subscription


expiration_type_id
integer
 Enum: 1 2 3 
 
Activation type: 1 = on sale, 2 = on first use, 3 = from specific date


is_allow_empty_code
boolean
 Default:  true
 
Personal vs shared subscription.


    

  • true = personal (only purchaser can use)
    • 

  • false = shared (multiple people can use with code)
    • 



is_united_balance
required
boolean
 
Balance type: true = unified balance, false = separate balance


united_balance_services_count
required
integer
 
Number of visits for unified balance


balance_edit_type_id
integer
 Enum: 0 1 2 
 
Balance adjustment permission: 0 = prohibited, 1 = only at sale location, 2 = at all locations


is_online_sale_enabled
boolean
 Default:  false
 
Whether online sale is enabled


online_sale_title
string
 
Subscription title for online sale


online_sale_description
string
 
Subscription description for online sale


online_sale_price
number <float> 
 
Price for online sale


online_image
string
 
Image URL for online sale


autoactivation_period
integer
 
Maximum autoactivation period


autoactivation_time_in_days
integer
 
Time units for autoactivation


autoactivation_time_unit_id
integer
 Enum: 1 2 3 4 
 
Autoactivation time unit: 1 = days, 2 = weeks, 3 = months, 4 = years


is_archived
boolean
 Default:  false
 
Whether subscription type is archived


services
Array of integers
 
List of service IDs. Pass empty array to preserve existing services.


service_categories
required
Array of integers
 
List of service category IDs. Pass empty array to preserve existing categories.


Array of objects
 
Time-based availability rules. Empty array = available anytime.


Responses
 Request samples 
Content type
application/json
{
  • "title": "Updated Fitness 10-pack",
  • "salon_group_id": 1,
  • "cost": 550,
  • "location_ids": [
    ],
  • "period": 90,
  • "period_unit_id": 1,
  • "allow_freeze": true,
  • "freeze_limit": 30,
  • "freeze_limit_unit_id": 1,
  • "service_price_correction": true,
  • "expiration_type_id": 1,
  • "is_allow_empty_code": true,
  • "is_united_balance": false,
  • "united_balance_services_count": 10,
  • "balance_edit_type_id": 2,
  • "is_online_sale_enabled": false,
  • "online_sale_title": "Updated Fitness Pack",
  • "online_sale_description": "Updated description",
  • "online_sale_price": 500,
  • "online_image": "https://example.com/images/updated.jpg",
  • "autoactivation_period": 3,
  • "autoactivation_time_in_days": 10,
  • "autoactivation_time_unit_id": 1,
  • "is_archived": false,
  • "services": [ ],
  • "service_categories": [ ],
  • "availability": [
    ]
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Delete subscription type 
Deletes a subscription type from the chain.


Warning: This action cannot be undone. Active subscriptions using this type
may be affected.


Authorizations:
bearer
path Parameters
chain_id
required
integer
 
 Example:  1
Chain ID


loyalty_abonement_type_id
required
integer
 
 Example:  468039
Subscription type ID to delete


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": [ ]
}
Clone subscription type 
Creates a copy of an existing subscription type with a new ID.


The cloned subscription type will:


    

  • Have the same settings (cost, period, services, etc.)
    • 

  • Get a modified title with " (2)" suffix automatically added
    • 

  • Have a new unique ID
    • 

  • Preserve all service/category links from the original
    • 



Note: Requires chain-level permissions.


Authorizations:
bearer
path Parameters
chain_id
required
integer
 
 Example:  1
Chain ID


loyalty_abonement_type_id
required
integer
 
 Example:  489159
Subscription type ID to clone


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Request Body schema: application/json
optional
object
 
Empty body required (or omit entirely)


Responses
 Request samples 
Content type
application/json
{ }
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
List certificate types 
Retrieves a list of certificate types at the chain level.


Returns all certificate types configured for the chain with optional filtering
and pagination.


Query Parameters:


    

  • title - Filter by certificate type name (partial match)
    • 

  • page - Page number (default: 1)
    • 

  • page_size - Items per page (default: 10, max: 100)
    • 



Item Type Restrictions:


    

  • 0 = All services and products
    • 

  • 1 = Any services (no products)
    • 

  • 2 = Any products (no services)
    • 

  • 3 = Specific services only (no products)
    • 

  • 4 = Specific services + any products
    • 



Expiration Types:


    

  • 0 = No expiration
    • 

  • 1 = Fixed date for all instances
    • 

  • 2 = Fixed period from sale date
    • 



Expiration Units:


    

  • 1 = day
    • 

  • 2 = week
    • 

  • 3 = month
    • 

  • 4 = year
    • 



Authorizations:
bearer
path Parameters
chain_id
required
integer
 
 Example:  706028
Chain ID


query Parameters
title
string
 
 Example:  title=Gift
Filter by certificate type name (partial match)


page
integer
 Default:  1
 
 Example:  page=1
Page number


page_size
integer  <= 100 
 Default:  10
 
 Example:  page_size=10
Items per page (max 100)


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Create certificate type 
Creates a new certificate type at the chain level.


Certificate types define gift certificate templates that can be sold across multiple locations.


Item Type Restrictions:


    

  • 0 = All services and products
    • 

  • 1 = Any services (no products)
    • 

  • 2 = Any products (no services)
    • 

  • 3 = Specific services only (no products)
    • 

  • 4 = Specific services + any products
    • 



Expiration Types:


    

  • 0 = No expiration
    • 

  • 1 = Fixed date for all instances
    • 

  • 2 = Fixed period from sale date
    • 



Expiration Units:


    

  • 1 = day
    • 

  • 2 = week
    • 

  • 3 = month
    • 

  • 4 = year
    • 



Balance Edit Types:


    

  • 1 = Can be edited
    • 

  • 2 = Cannot be edited
    • 



Note: After creation, certificate products are automatically created in warehouse.


Authorizations:
bearer
path Parameters
chain_id
required
integer
 
 Example:  706028
Chain ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Request Body schema: application/json
required
title
required
string
 
Certificate type name


balance
required
number
 
Certificate face value


is_multi
required
boolean
 
true = multiple use, false = single use


item_type_id
required
integer
 Enum: 0 1 2 3 4 
 
Usage restrictions (0-4)


is_allow_empty_code
required
boolean
 
Allow selling without code?


category_id
integer or null
 
Service category restriction (null = no restriction)


balance_edit_type_id
required
integer
 Enum: 1 2 
 
Balance editability (1 = editable, 2 = not editable)


service_ids
required
Array of integers
 
Specific service IDs (empty if no restriction)


salon_ids
required
Array of integers
 
Location IDs where certificate is valid


required
object
 
Expiration settings


required
object
 
Online sale settings


Responses
 Request samples 
Content type
application/json
{
  • "title": "Gift Certificate 1000",
  • "balance": 1000,
  • "is_multi": true,
  • "item_type_id": 0,
  • "is_allow_empty_code": false,
  • "category_id": null,
  • "balance_edit_type_id": 1,
  • "service_ids": [ ],
  • "salon_ids": [
    ],
  • "expiration": {
    },
  • "online_sale": {
    }
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get certificate type 
Retrieves a specific certificate type by ID at the chain level.


Returns complete certificate type configuration including expiration rules,
restrictions, and online sale settings.


Authorizations:
bearer
path Parameters
chain_id
required
integer
 
 Example:  706028
Chain ID


type_id
required
integer
 
 Example:  289056
Certificate type ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Update certificate type 
Updates an existing certificate type at the chain level.


All fields from creation are required. Use GET first to retrieve current values,
then modify needed fields and send complete object.


Note: Cannot update certificate types that have already been issued.


Authorizations:
bearer
path Parameters
chain_id
required
integer
 
 Example:  706028
Chain ID


type_id
required
integer
 
 Example:  289056
Certificate type ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Request Body schema: application/json
required
title
required
string
 
Certificate type name


balance
required
number
 
Certificate face value


is_multi
required
boolean
 
true = multiple use, false = single use


item_type_id
required
integer
 Enum: 0 1 2 3 4 
 
Usage restrictions (0-4)


is_allow_empty_code
required
boolean
 
Allow selling without code?


category_id
integer or null
 
Service category restriction (null = no restriction)


balance_edit_type_id
required
integer
 Enum: 1 2 
 
Balance editability (1 = editable, 2 = not editable)


service_ids
required
Array of integers
 
Specific service IDs (empty if no restriction)


salon_ids
required
Array of integers
 
Location IDs where certificate is valid


required
object
 
Expiration settings


required
object
 
Online sale settings


Responses
 Request samples 
Content type
application/json
{
  • "title": "Gift Certificate 1500",
  • "balance": 1500,
  • "is_multi": true,
  • "item_type_id": 0,
  • "is_allow_empty_code": false,
  • "category_id": null,
  • "balance_edit_type_id": 1,
  • "service_ids": [ ],
  • "salon_ids": [
    ],
  • "expiration": {
    },
  • "online_sale": {
    }
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Freeze subscription 
Freezes a subscription (abonement) until the specified date.


The subscription's expiration date will be extended by the freeze period.
Frozen subscriptions cannot be used for bookings.


Requirements:


    

  • Subscription type must have allow_freeze: true
    • 

  • Freeze period must not exceed freeze_limit from subscription type
    • 



Note: Requires chain-level permissions.


Authorizations:
bearer
path Parameters
chain_id
required
integer
 
 Example:  706028
Chain ID


abonement_id
required
integer
 
 Example:  123
Subscription ID to freeze


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Request Body schema: application/json
required
freeze_till
required
string <date-time> 
 
Date until which the subscription will be frozen (ISO 8601 format)


Responses
 Request samples 
Content type
application/json
{
  • "freeze_till": "2025-12-31T23:59:59+00:00"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Unfreeze subscription 
Removes the freeze from a subscription (abonement).


The subscription's expiration date will remain extended by the freeze period
that was already applied during the freeze.


Note: Requires chain-level permissions.


Authorizations:
bearer
path Parameters
chain_id
required
integer
 
 Example:  706028
Chain ID


abonement_id
required
integer
 
 Example:  123
Subscription ID to unfreeze


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Request Body schema: application/json
optional
object
 
Empty body required (or omit entirely)


Responses
 Request samples 
Content type
application/json
{ }
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Change subscription balance 
Modifies the remaining visit count for a subscription (abonement).


For unified balance subscriptions:


    

  • Use united_balance_services_count to set total visits
    • 



For separate balance subscriptions:


    

  • Use services_balance_count array with service_id and balance for each service/category
    • 



Use cases:


    

  • Adjust balance after administrative changes
    • 

  • Correct errors in visit counts
    • 

  • Add bonus visits
    • 



Note: Requires chain-level permissions.


Authorizations:
bearer
path Parameters
chain_id
required
integer
 
 Example:  706028
Chain ID


abonement_id
required
integer
 
 Example:  123
Subscription ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Request Body schema: application/json
required
united_balance_services_count
integer
 
New visit count for unified balance subscriptions


Array of objects
 
New balance for separate balance subscriptions (per service/category)


Responses
 Request samples 
Content type
application/json
{
  • "united_balance_services_count": 10,
  • "services_balance_count": [
    ]
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Change subscription validity period 
Modifies the validity period (duration) of a subscription (abonement).


This changes how long the subscription remains active before expiring.


Period units:


    

  • 1 = day
    • 

  • 2 = week
    • 

  • 3 = month
    • 

  • 4 = year
    • 



Use cases:


    

  • Extend expiration as customer service gesture
    • 

  • Adjust period after policy changes
    • 

  • Correct administrative errors
    • 



Note: Requires chain-level permissions.


Authorizations:
bearer
path Parameters
chain_id
required
integer
 
 Example:  706028
Chain ID


abonement_id
required
integer
 
 Example:  123
Subscription ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}, User {user_token}


Request Body schema: application/json
required
period
required
integer
 
Duration value


period_unit_id
required
integer
 Enum: 1 2 3 4 
 
Period unit: 1 = day, 2 = week, 3 = month, 4 = year


Responses
 Request samples 
Content type
application/json
{
  • "period": 90,
  • "period_unit_id": 1
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Create a Chain Promotion 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
integer
 
Chain ID


query Parameters
include
string
 Enum: "applicable_items" "rules" "companies" "loyalty_card_types" "on_changed_notification_template" "on_expiration_notification_template" 
 
Include additional resources in the answer


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
required
title
required
string
 
Share name


type
required
string
 Enum: "discount_static" "discount_accumulative_visits" "discount_accumulative_sold" "discount_accumulative_paid" "cashback_static_sold" "cashback_static_paid" "cashback_accumulative_paid" "cashback_accumulative_sold" "cashback_accumulative_paid_visits" "cashback_accumulative_sold_visits" "cashback_sold_visits" "cashback_paid_visits" "package_discount" 
 
Promotion type


service_item_type
required
string
 Enum: "any_allowed" "not_allowed" "custom_allowed" 
 
Type of application to services


good_item_type
required
string
 Enum: "any_allowed" "not_allowed" "custom_allowed" 
 
Type of application to products


value_unit
required
string
 Enum: "percent" "amount" 
 
Bonus or discount measurement unit (percentage, fixed amount)


usage_limit
integer <int32> 
 
Limit on the number of applications (only for cashback)


visit_multiplicity
integer <int32> 
 
Multiplicity of application by visits (only for cashback)


sold_items_multiplicity
integer <int32> 
 
How many services you need to pay to get a discount on promotional services (only for the promotion type "Discount by condition")


expiration_timeout
integer <int32> 
 
Expiration date of bonuses or discounts


expiration_timeout_unit
string
 Enum: "day" "week" "month" "year" 
 
The unit of measurement for the expiration date of bonuses or discounts


expiration_notification_timeout
integer <int32> 
 
How many days before the bonus or discount expires, a notification must be sent to the client


params_source_type
string
 Enum: "loyalty_card" "active_companies" "chain" 
 
Where to get the client's history to calculate the size of the bonus or discount (for accumulation promotions or conditional discounts)


history_start_date
string <date> 
 
From what date to take into account the client's history to calculate the size of the bonus or discount (for accumulative promotions or conditional discounts)


loyalty_card_type_ids
Array of integers <int32> [ items <int32 > ]
 
Identifiers of types of cards for which the promotion is valid


object (loyalty_notification_message_template_request) 
 
Body of the request to bind the loyalty notification template


object (loyalty_notification_message_template_request) 
 
Body of the request to bind the loyalty notification template


required
Array of objects (Root Type for LoyaltyProgramRuleRequest) 
 
Rules for determining the value of the bonus or discount (only one rule is allowed for fixed promotions)


company_ids
required
Array of integers <int32> [ items <int32 > ]
 
Identifiers of locations where the promotion is valid


allowed_service_ids
Array of integers <int32> [ items <int32 > ]
 
Service and service category identifiers (if application type is set for some services)


allowed_good_ids
Array of integers <int32> [ items <int32 > ]
 
Item IDs (if application type is set for some items)


allowed_good_category_ids
Array of integers <int32> [ items <int32 > ]
 
Product category identifiers (if application type is set for some products)


Responses
 Request samples 
Content type
application/json
{
  • "title": "Cumulative discount for some services and not for goods",
  • "type": "discount_accumulative_paid",
  • "service_item_type": "custom_allowed",
  • "good_item_type": "not_allowed",
  • "allowed_service_ids": [
    ],
  • "allowed_good_ids": [ ],
  • "allowed_good_category_ids": [ ],
  • "value_unit": "percent",
  • "usage_limit": 0,
  • "visit_multiplicity": 0,
  • "sold_items_multiplicity": 0,
  • "expiration_timeout": 6,
  • "expiration_timeout_unit": "month",
  • "expiration_notification_timeout": 7,
  • "params_source_type": "chain",
  • "history_start_date": "2025-09-21",
  • "loyalty_card_type_ids": [
    ],
  • "on_changed_notification_template": {
    },
  • "on_expiration_notification_template": {
    },
  • "rules": [
    ],
  • "company_ids": [
    ]
}
 Response samples 
Content type
application/json
{
  • "id": 34,
  • "title": "Cumulative discount for some services and not for goods",
  • "type": "discount_accumulative_paid",
  • "service_item_type": "custom_allowed",
  • "good_item_type": "not_allowed",
  • "value_unit": "percent",
  • "usage_limit": 0,
  • "visit_multiplicity": 0,
  • "sold_items_multiplicity": 0,
  • "expiration_timeout": 6,
  • "expiration_timeout_unit": "month",
  • "expiration_notification_timeout": 7,
  • "params_source_type": "chain",
  • "history_start_date": "2025-09-21",
  • "on_changed_notification_template_id": 55,
  • "on_expiration_notification_template_id": 84,
  • "loyalty_card_types": [
    ],
  • "on_changed_notification_template": {
    },
  • "on_expiration_notification_template": {
    },
  • "rules": [
    ],
  • "companies": [
    ],
  • "applicable_items": [
    ]
}
Get a Chain Promotion 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
integer
 
Chain ID


loyalty_program_id
required
integer
 
Promotion ID


query Parameters
include
string
 Enum: "applicable_items" "rules" "companies" "loyalty_card_types" "on_changed_notification_template" "on_expiration_notification_template" 
 
Include additional resources in the answer


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "id": 34,
  • "title": "Cumulative discount for some services and not for goods",
  • "type": "discount_accumulative_paid",
  • "service_item_type": "custom_allowed",
  • "good_item_type": "not_allowed",
  • "value_unit": "percent",
  • "usage_limit": 0,
  • "visit_multiplicity": 0,
  • "sold_items_multiplicity": 0,
  • "expiration_timeout": 6,
  • "expiration_timeout_unit": "month",
  • "expiration_notification_timeout": 7,
  • "params_source_type": "chain",
  • "history_start_date": "2025-09-21",
  • "on_changed_notification_template_id": 55,
  • "on_expiration_notification_template_id": 84,
  • "loyalty_card_types": [
    ],
  • "on_changed_notification_template": {
    },
  • "on_expiration_notification_template": {
    },
  • "rules": [
    ],
  • "companies": [
    ],
  • "applicable_items": [
    ]
}
Edit Chain Promotion 
Authorizations:
bearer
path Parameters
chain_id
required
integer
 
Chain ID


loyalty_program_id
required
integer
 
Promotion ID


query Parameters
include
string
 Enum: "applicable_items" "rules" "companies" "loyalty_card_types" "on_changed_notification_template" "on_expiration_notification_template" 
 
Include additional resources in the answer


Request Body schema: application/json
required
title
string
 
Share name


usage_limit
integer <int32> 
 
Limit on the number of applications (only for cashback)


expiration_timeout
integer <int32> 
 
Expiration date of bonuses or discounts


expiration_timeout_unit
string
 Enum: "day" "week" "month" "year" 
 
The unit of measurement for the expiration date of bonuses or discounts


expiration_notification_timeout
integer <int32> 
 
How many days before the bonus or discount expires, a notification must be sent to the client


loyalty_card_type_ids
Array of integers <int32> [ items <int32 > ]
 
Identifiers of types of cards for which the promotion is valid


object (loyalty_notification_message_template_request) 
 
Body of the request to bind the loyalty notification template


object (loyalty_notification_message_template_request) 
 
Body of the request to bind the loyalty notification template


Array of objects (Root Type for LoyaltyProgramRuleRequest) 
 
Rules for determining the value of the bonus or discount (only one rule is allowed for fixed promotions)


company_ids
Array of integers <int32> [ items <int32 > ]
 
Identifiers of locations where the promotion is valid


allowed_service_ids
Array of integers <int32> [ items <int32 > ]
 
Service and service category identifiers (if application type is set for some services)


allowed_good_ids
Array of integers <int32> [ items <int32 > ]
 
Item IDs (if application type is set for some items)


allowed_good_category_ids
Array of integers <int32> [ items <int32 > ]
 
Product category identifiers (if application type is set for some products)


Responses
 Request samples 
Content type
application/json
{
  • "title": "Cumulative discount for some services and not for goods",
  • "allowed_service_ids": [
    ],
  • "allowed_good_ids": [ ],
  • "allowed_good_category_ids": [ ],
  • "usage_limit": 0,
  • "expiration_timeout": 6,
  • "expiration_timeout_unit": "month",
  • "expiration_notification_timeout": 7,
  • "loyalty_card_type_ids": [
    ],
  • "on_changed_notification_template": {
    },
  • "on_expiration_notification_template": {
    },
  • "rules": [
    ],
  • "company_ids": [
    ]
}
 Response samples 
Content type
application/json
{
  • "id": 34,
  • "title": "Cumulative discount for some services and not for goods",
  • "type": "discount_accumulative_paid",
  • "service_item_type": "custom_allowed",
  • "good_item_type": "not_allowed",
  • "value_unit": "percent",
  • "usage_limit": 0,
  • "visit_multiplicity": 0,
  • "sold_items_multiplicity": 0,
  • "expiration_timeout": 6,
  • "expiration_timeout_unit": "month",
  • "expiration_notification_timeout": 7,
  • "params_source_type": "chain",
  • "history_start_date": "2025-09-21",
  • "on_changed_notification_template_id": 55,
  • "on_expiration_notification_template_id": 84,
  • "loyalty_card_types": [
    ],
  • "on_changed_notification_template": {
    },
  • "on_expiration_notification_template": {
    },
  • "rules": [
    ],
  • "companies": [
    ],
  • "applicable_items": [
    ]
}
Delete Chain Promotion 
Authorizations:
bearer
path Parameters
chain_id
required
integer
 
Chain ID


loyalty_program_id
required
integer
 
Promotion ID


query Parameters
include
string
 Enum: "applicable_items" "rules" "companies" "loyalty_card_types" "on_changed_notification_template" "on_expiration_notification_template" 
 
Include additional resources in the answer


Responses
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Get a List of Chain Loyalty Transactions 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
integer
 
Chain ID


query Parameters
created_after
required
string <date> 
 
Sample start date in Y-m-d format


created_before
required
string <date> 
 
Sample end date in Y-m-d format


types
Array of strings
Items Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" 
 
Types of loyalty transactions included in the selection: 1 - Promotion discount, 2 - Loyalty program accrual, 3 - Loyalty card withdrawal, 4 - Referral program accrual, 5 - Manual replenishment, 6 - Manual withdrawal, 7 - Overdue points withdrawal , 8 - Withdrawal from the gift card, 9 - Use of the membership, 10 - Recalculation of the cost of the membership, 11 - Withdrawal from the personal account


company_ids
Array of integers
 
Loyalty transaction affiliate IDs included in the sample


visit_ids
Array of integers
 
Loyalty transaction visit IDs included in the sample


page
integer
 
Selection page


count
integer
 
Number of results per selection page


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get a list of loyalty notification templates 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
integer
 
Chain ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
[
  • {
    }
]
Fiscalization
Fiscal integration for tax compliance. Manage fiscal transactions, print fiscal receipts, and configure tax systems.


Get fiscal transactions 
Filters






Parameter
Description





page
Page number




editable_length
Number of clients per page




type
Operation type




status
Operation status




start_date
Period start date




end_date
Period end date






Types of all transactions with cash register






Meaning
Description





0
Sales operation – Active for documents of type Visit




1
Sale return operation – Active for documents of type Visit




2
Correction operation




4
Shift opening operation – Opens a new POS shift




5
Shift closing operation – Closes the current POS shift




9
Get POS status – Retrieves the current status of the POS device




11
Get POS team status – Retrieves the status of all POS devices connected to the team




12
Correction operation




13
Print X-report – Prints a non-fiscal summary report of the current shift




6
Cash deposit – Registers a cash-in transaction in the POS




7
Cash withdrawal – Registers a cash-out transaction in the POS





Statuses of All POS Operations






Meaning
Description





0
Connection error with POS – Unable to establish a connection with the POS device




1
Success – Operation completed successfully




2
Sent for printing – The request has been sent to the POS and is waiting for print completion




3
Runtime error – An error occurred while processing the operation on the POS device




4
Status check error – Failed to retrieve the current status of the POS




5
Waiting for POS readiness – Operation is pending until the POS device becomes ready





Document Types






Meaning
Description





1
Sale of products




2
Provision of services




3
Arrival of products




4
Products write-off




5
Transfer of products




6
Inventory




7
Visit




8
Consumables write-off




9
Deposit replenishment





Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


query Parameters
page
number
 
 Example:  page=1
Page number


editable_length
number
 
 Example:  editable_length=25
Number of customers per page


type
number
 
 Example:  type=20
Type of transaction


status
number
 
 Example:  status=6
Operation status


start_date
number
 
 Example:  start_date=20251201
Period start date


end_date
number
 
 Example:  end_date=20251231
Period end date


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer access_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Print fiscal receipt 
Types of all transactions with cash register






Meaning
Description





0
Sale operation (active for documents with types "Visit" and "Deposit replenishment")




1
Sale return operation (active for documents with types "Visit" and "Deposit replenishment")




2
Correction operation




4
Shift opening operation – Opens a new POS shift




5
Shift closing operation – Closes the current POS shift




9
Get POS status – Retrieves the current status of the POS device




11
Get POS team status – Retrieves the status of all POS devices connected to the team




12
Correction operation




13
Print X-report – Prints a non-fiscal summary report of the current shift




6
Cash deposit – Registers a cash-in transaction in the POS




7
Cash withdrawal – Registers a cash-out transaction in the POS





Document Types






Meaning
Description





1
Sale of products




2
Provision of services




3
Arrival of products




4
Products write-off




5
Transfer of products




6
Inventory




7
Visit




8
Consumables write-off




9
Deposit replenishment





Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
Location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Request Body schema: */*
optional
document_id
required
number
 
Document ID


type
required
number
 
type of operation with cash register (see table of types of all operations)


is_pos_enabled
boolean
 
enable POS terminal (default false)


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
List request example 
A list of tax systems and VAT available for a country can be obtained by requesting the country ID for which the list is to be obtained.
The country ID can be obtained from list of countries.


The list is an array of tax systems with a nested VAT array for each tax system.


The taxation system has the following structure:






Field
Type
Description





title
string
Name of taxation system




slug
string
Code name for the taxation system




vats
Array of objects(Vat[])
List of available VAT for the taxation system






VAT has the following structure:






Field
Type
Description





title
string
Title VAT




slug
string
Code name VAT





Authorizations:
bearer
path Parameters
country_id
required
number
 
 Example:  1
Country ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Example of a request in case of successful fiscalization or in case of an error 
Authorizations:
bearer
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Conetnt-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Request Body schema: application/json
optional
object
 
Responses
 Request samples 
Content type
application/json
{ }
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Example of a request for fiscalization of a document 
Authorizations:
bearer
header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Request Body schema: application/json
required
id
string
 
Unique ID of the sales document


date
string <date-time> 
 
Date and time the document was sent for printing (in ISO-8601 format)


document_id
integer <int32> 
 
Internal document identifier in the Altegio system


type
string
 Enum: "sale" "return" 
 
Document type (list of possible values)


print_receipt
boolean
 
Whether to print a paper check at the checkout during fiscalization


object
 
Client entity


Array of objects
 
List of positions in the check


Array of objects
 
List of fees applied per check


tax
string
 
Type of taxation system (slug from the list of taxation systems)


object
 
The Essence of a Cashier


object
 
Options for the connected POS terminal


callback_url
string
 
Link to update fiscal status


custom_text
string
 
Arbitrary text for printing on a receipt


Responses
 Request samples 
Content type
application/json
{
  • "id": "d72fece5-6825-4895-9395-0133195612a4",
  • "date": "2025-09-21T23:00:00.000+03:00",
  • "document_id": 239083104,
  • "type": "sale",
  • "print_receipt": true,
  • "customer": {},
  • "positions": [
    ],
  • "payments": [
    ],
  • "tax": "ru_osn",
  • "cashier": {
    },
  • "pos": {
    },
  • "callback_url": "https://app.alteg.io/api/v1/integration/kkm/callback/",
  • "custom_text": "some custom text"
}
 Response samples 
Content type
application/json
{
  • "id": "d72fece5-6825-4895-9395-0133195612a4",
  • "status": "success",
  • "code": 0,
  • "message": "OK"
}
Utilities
Utility endpoints for validation, GDPR, image management, licensing, and tips configuration.


Phone number format check 
The transferred phone number is checked for compliance with Altegio rules.


Authorizations:
(beareruser) 
path Parameters
phone
required
string
 
Checked phone number


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Obtaining information about the rules for processing personal data of the company 
Authorizations:
bearer
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Image upload 
The response object has the following fields:






Field
Type
Description





image_binded
boolean
Status of linking images to an entity




image_group
object
Image group object





Authorizations:
(beareruser) 
path Parameters
entity
required
string
 
 Example:  "master"
entity name (master/service)


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
form-data


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: multipart/form-data
required
company_id
number
 
Location ID for image binding (for entity=service)


service_id
number
 
Service ID for image binding (for entity=service)


master_id
number
 
team member ID for image binding (for entity=master)


image
required
string
 
transferred image (image/jpeg, image/png)


Responses
 Response samples 
Content type
application/json
{}
Deleting images 
The response object has the following fields:






Field
Type
Description





success
boolean
Deletion result





Authorizations:
(beareruser) 
path Parameters
entity
required
string
 
entity name (master/service)


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
form-data


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: multipart/form-data
required
image_group_id
required
number
 
Image group ID to delete


Responses
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Get feedback form status 
Authorizations:
bearer
path Parameters
record_token
required
string
 
Short appointment token


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
{}
Submitting a feedback form 
Authorizations:
(beareruser) 
path Parameters
record_token
required
string
 
Short appointment token


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Request Body schema: application/json
required
rating
required
integer <int32> 
 
Rating for the review (number of stars from 1 to 5)


text
string
 
Feedback text


tips_amount
number <double> 
 
Tip amount


redirect_prefix
string
 
The prefix part of the url that will be redirected to after returning from the payment form


Responses
 Request samples 
Content type
application/json
{}
 Response samples 
Content type
application/json
{}
Get a list of location employees with their tip settings 
Authorizations:
(beareruser) 
path Parameters
location_id
required
integer
 
location ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}
Disable Tips for the team member 
Authorizations:
(beareruser) 
path Parameters
location_id
required
integer
 
location id


master_tips_settings_id
required
integer
 
tip settings id


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{}
Enable Tips for the team member 
Authorizations:
(beareruser) 
path Parameters
master_tips_settings_id
required
integer
 
tip settings id


location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{}
Marketplace
Application marketplace integration for third-party applications.


Integration workflow:


    

  • Partner provides domain name, registration URL, and callback URL
    • 

  • User authorizes and is redirected to partner registration page
    • 

  • Partner redirects back to Altegio after successful registration
    • 

  • Partner confirms service activation via payment callback
    • 



Data About Locations Connected to the Application 
This endpoint retrieves a list of locations that have connected a specific application, along with detailed information about each.


Authorizations:
bearer
path Parameters
application_id
required
number
 
Application ID


query Parameters
page
required
number
 
Page number


count
required
number  <= 1000 
 
Number of elements per page


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Get application tariffs 
Retrieves list of tariffs for the application.


Note: For marketplace partners only.


Authorizations:
bearer
path Parameters
application_id
required
integer
 
 Example:  123
Application ID


header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Authorization
required
string
 
Bearer {partner_token}


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Set payment discount for locations 
Sets a payment discount for specific locations when they pay through Altegio platform.


Note: This endpoint is intended for marketplace partners only.
Requires marketplace partner authorization.


Authorizations:
bearer
header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}


Request Body schema: application/json
required
salon_ids
required
Array of integers
 
List of location IDs to apply discount


application_id
required
integer
 
Application ID from marketplace


discount
required
number <float> 
 
Discount amount (percentage or fixed amount depending on configuration)


Responses
 Request samples 
Content type
application/json
{
  • "salon_ids": [
    ],
  • "application_id": 123,
  • "discount": 15.54
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": [ ]
}
Update notification channel availability 
Updates available notification channels for the application.


Note: Only for Chat Bots and SMS Aggregators category applications.
For marketplace partners only.


Authorizations:
bearer
header Parameters
Accept
required
string
 Default:  application/vnd.api.v2+json
 
Content-Type
required
string
 Default:  application/json
 
Authorization
required
string
 
Bearer {partner_token}


Request Body schema: application/json
required
salon_id
required
integer
 
Location ID


application_id
required
integer
 
Application ID


channel_slug
required
string
 Enum: "sms" "whatsapp" 
 
Channel to update availability for


is_available
required
boolean
 
Channel availability flag


Responses
 Request samples 
Content type
application/json
{
  • "salon_id": 123,
  • "application_id": 456,
  • "channel_slug": "sms",
  • "is_available": true
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": { },
  • "meta": [ ]
}
Application Status Data for Any Location 
This endpoint is used to retrieve information about the application's installation status in a specific location.


Authorizations:
bearer
path Parameters
location_id
required
number
 
Location ID


application_id
required
number
 
Application ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    }
}
Application Uninstall 
This endpoint is used by the partner service to uninstall the application from a specific location.


Authorizations:
bearer
path Parameters
location_id
required
number
 
Location ID


application_id
required
number
 
Application ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}
Application Installation for a Location 
The integration settings of the partner service must be sent to this address. Once received, the application will be configured and installed for the corresponding location.


Authorizations:
bearer
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Request Body schema: application/json
salon_id
required
number
 
Location ID.


application_id
required
number
 
Application ID.


api_key
number
 
API-key for messaging module.


webhook_urls
Array of strings
 
Webhooks array


Responses
 Request samples 
Content type
application/json
{
  • "salon_id": 123,
  • "application_id": 123,
  • "api_key": "2f181e2a-5c22-4ae7-9d9b-07104f312c28",
  • "webhook_urls": []
}
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Redirect URL after user registration with the partner service 
After completing registration, the user must be redirected to this URL in the browser, along with any required data needed by the partner service.


Authorizations:
bearer
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Request Body schema: application/json
salon_id
required
number
 
Location ID.


application_id
required
number
 
Application ID.


api_key
number
 
API-key for messaging module.


webhook_urls
Array of strings
 
Webhooks array


Responses
 Request samples 
Content type
application/json
{
  • "salon_id": 123,
  • "application_id": 123,
  • "api_key": "2f181e2a-5c22-4ae7-9d9b-07104f312c28",
  • "webhook_urls": []
}
 Response samples 
Content type
application/json
{
  • "success": true
}
Notify Altegio of Successful Payment 
A webhook notification must be sent to this address to inform Altegio of a successful payment made on the partner service’s side.


Authorizations:
bearer
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Request Body schema: application/json
salon_id
required
number
 
Location ID.


application_id
required
number
 
Application ID.


currency_iso
required
string
 
Currency ISO (e.g.: USD, EUR, BYN)


payment_sum
required
number
 
Payment amount.


payment_date
required
string
 
Date and time of payment.


period_from
required
string
 
Date from which the paid period begins (inclusive).


period_to
required
string
 
Date from which the paid period ends (inclusive).


Responses
 Request samples 
Content type
application/json
{
  • "salon_id": 123,
  • "application_id": 123,
  • "currency_iso": "EUR",
  • "payment_sum": 990.99,
  • "payment_date": "2022-01-01 10:10:00",
  • "period_from": "2022-01-01 10:10:00",
  • "period_to": "2022-02-01 10:10:00"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    }
}
Chargeback Notice 
Chargeback Notice


Authorizations:
bearer
path Parameters
payment_id
required
number
 
 Example:  123
Payment ID.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Notify Altegio of Available SMS Sender Names 
This endpoint is used to send the list of SMS sender names available to the user. The user will be able to choose from any of the provided sender names.


Authorizations:
bearer
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Request Body schema: application/json
salon_id
required
number
 
Location ID.


application_id
required
number
 
Application ID


short_names
required
Array of strings
 
Array of SMS names


Responses
 Request samples 
Content type
application/json
{
  • "salon_id": 123,
  • "application_id": 123,
  • "short_names": [
    ]
}
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Webhook from Altegio About Application Events 
Note: This is not a callable endpoint.


This section describes how Altegio sends webhook notifications when specific events occur in the application-to-location lifecycle. The following event types are currently supported:


    

  • uninstall — Sent when the application is disabled on the Altegio side.
    • 

  • freeze — Sent when the integration is frozen due to service expiration.
    • 



You can configure the webhook URL for receiving these events in your Altegio Developer Account.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Request Body schema: application/json
salon_id
required
number
 
Location ID.


application_id
required
number
 
Application ID.


event
required
string
 Enum: "uninstall" "freeze" 
 
Event Slug.


partner_token
required
string
 
Bearer token of the developer's location (to verify the origin of the webhook)


Responses
 Request samples 
Content type
application/json
{
  • "salon_id": 123,
  • "application_id": 123,
  • "event": "uninstall",
  • "partner_token": "yasdfkjah2328aj"
}
 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Webhooks
Webhook configuration for receiving real-time event notifications from Altegio.


Get event notification settings 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Change Event Notification Settings 
Authorizations:
(beareruser) 
path Parameters
location_id
required
number
 
location ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
optional
urls
required
Array of arrays
 
List of addresses to send notifications to


active
required
number
 
1 - notifications are active, 0 - not active


salon
number
 
1 - send events by location entity, 0 - do not send


service_category
number
 
1 - send events by service category entity, 0 - do not send


service
number
 
1 - send events by service entity, 0 - do not send


good
number
 
1 - send events by product entity, 0 - don't send


master
number
 
1 - send events by team member entity, 0 - don't send


client
number
 
1 - send events by client entity, 0 - don't send


record
number
 
1 - send events by record entity, 0 - do not send


goods_operations_sale
number
 
1 - send events by the item sale entity, 0 - do not send


goods_operations_receipt
number
 
1 - send events by the entity arrival of goods, 0 - do not send


goods_operations_consumable
number
 
1 - send events by the consumable write-off entity, 0 - do not send


goods_operations_stolen
number
 
1 - send events by the item write-off entity, 0 - do not send


goods_operations_move
number
 
1 - send events by the item movement entity, 0 - no send


finances_operation
number
 
1 - send events by entity financial operation, 0 - no send


self_sending
number
 
1 - The webhook creator will receive events triggered by their own actions, 0 - The webhook creator will not receive events triggered by their own actions


Responses
 Request samples 
Content type
application/json
{
  • "urls": [],
  • "active": 0,
  • "salon": 1,
  • "service_category": 0,
  • "service": 1,
  • "good": 1,
  • "master": 1,
  • "client": 1,
  • "record": 1,
  • "goods_operations_sale": 1,
  • "goods_operations_receipt": 1,
  • "goods_operations_consumable": 1,
  • "goods_operations_stolen": 1,
  • "goods_operations_move": 1,
  • "finances_operation": 1,
  • "self_sending": 0
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Dictionaries
Reference data including countries, cities, business types, and industry classifications.


Get a list of countries 
Authorizations:
bearer
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Get a list of cities 
Authorizations:
bearer
query Parameters
country_id
number
 
Country ID to get cities from


company_id
number
 
Location ID. If passed, the city of the location will also be returned, regardless of whether it belongs to the specified country or not


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Get business types by group 
Authorizations:
(beareruser) 
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{}