Documentation updated: 2026-09-16

This is official API for integration external applications with AI Helps products Beauty Pro and Fitness Pro.

API tends to follow REST principles.

API root URL for HTTP requests is: https://api.aihelps.com/v1/

API status page: https://api.aihelps.com/status

Questions about API: https://t.me/joinchat/J1-qj0gTp_i6EmE2rtvGvw (Telegram channel)

AI Helps API consultant: https://chatgpt.com/g/g-69a06e7b02908191818b18d2b77f1f40-ai-helps-api-consultant

About API

Getting started

To obtain credentials for a test sandbox:

1. Contact AI Helps or your account manager to register an application via CRM (or ask support at api@aihelps.com).
2. You receive application_id and application_secret (shown once - keep the secret safe).
3. The databases field on the application limits which database codes the app may access (use test database codes for sandbox).
4. Call GET /auth/application, then GET /auth/database with a test database_code to obtain a database access token.
5. Each new application is reviewed before production access is granted.
6. Choose appropriate Scopes when registering - they determine which endpoints your application can call.

Data history limit

By default, historical data available through the API is limited to the last 2 months. This applies to appointments and appointment items, sales, client history (GET /clients/{id}/history), client change logs (GET /clients/changeLogs), appointment change logs (GET /appointments/changeLogs), and dashboard reports. If you need older data, contact AI Helps support individually.

API versioning

Current API version is "Version 1". Version information is mandatory in API URL and described as v{number}, where {number} is integer, starting from 1 (current version is 1).

Versioning rules are following:

1. New API methods can be added without incrementing version number.
2. New parameters can be added to existing API methods if they don"t change API behavior with these new parameters missing.
3. Changing API URLs, parameters names or their behaviour will increment version number.
4. Removing some API URLs or parameters names will increment version number.

These rules guarantee that code, working with specific API version won"t broke on minor changes made. All changes that potentially can break code will be presented in new version.

Last API version is considered "public". All developers will be notified about API version incremented, if they provided contact_email (see Application account section).
Old API version will be available at least 2 months (it can happens that several old versions will be available) and this period can be extended by request.

All ideas, errors and propositions can be sent to Telegram channel https://t.me/joinchat/J1-qj0gTp_i6EmE2rtvGvw.

HTTPS protocol

All API available only through HTTPS (HTTP not available for both public/private API).

Current server supports TLS 1.0, 1.1 and 1.2 (SSL 1-3 commonly recognized vulnerable)

REST API with extensions

Current API implementation uses REST API guidelines. According to idea, that in most cases API is used for both get/update data, in many cases with local store, resources representation seems to be better choice than GraphQL "mostly read with complex views" idea and gRPC "all is call" idea (more useful in some-transaction-like APIs). According to that, REST API seems to be the most natural way for our API, taking into account our specifics, GraphQL has some promising features can be useful and gRPC usage is far from our case, so we didn't took it into account.

So, AI Helps API fulfills REST principles: client-server, stateless, cacheable (not important in our case), uniform interface and layered system.
Resources are identified in /resources/{id} way (subresources /resources/{id}/subresources/{id2} and so on), methods to work with resources are GET, POST, PUT and DELETE.

API URI usually represents either list of resources (e.g. \clients) or specific resource from list, given by id (e.g. \clients\{id}).
Next table describes what methods can be used to operate with data:

API url	GET	POST	PUT	DELETE
List of resources (e.g. \clients)	get all resources	create new resource	nothing	nothing
Specific resource (e.g. \clients\{id})	get resource by id	nothing	update resource	delete resource

Not all methods will be available for all lists or resources, see detailed documentation below.
If method not available for given API URL, response with HTTP status code 404 (Not Found) will be returned.

We also took best ideas from GraphQL and implemented in our API:

1. While retrieving data you forced to pass fields you want to get. This idea gives more efficient data loading and easier API usage - even if we add extra fields, you will not receive them until explicitly requested.
2. To add or update resource you can pass only part of fields - you do not need to pass all fields. While update, non-passed fields will leave unchanged (so, no more need for PATCH method). This greatly simplifies API usage and decrease API complexity. Along with previous idea this makes API much more flexible and easy to use (non-fixed data structure).
3. In some situations API can be used mostly to read complex data without close to zero changes. So we added complex read-only or read-write fields to our resources. Such "fields" can be retrieved and updated in same request with main resource, greatly decreasing complexity of client code, number of requests and speed. These "fields" are specific for each resource and fine-tuned for speed (contrary to GraphQL where complex structure is hard to tune), still reach enough to satisfy client needs.
4. We also implemented subscription for changes for all resources in API with WebHooks.

May be in future we also will add GraphQL wrapper around our REST API, so you will be able to use GraphQL client libraries.

Data format

All API methods use JSON for both input and output. For some requests (all GET requests) body not needed, for DELETE server returns nothing.

For retrieving images, where response will be image itself, for updating image request body is image itself.

ContentType (application/json) is not mandatory for requests and can be skipped, but server always return content type
(application/json for 200/201 responces (do not return content type for 204 (No content)) and image/jpeg or image/png for images).

XML not supported now and no plans to support it in future.

All API requests should use UTF-8 encoding, all responses also in UTF-8.

We recommend you use Postman to test our API.
//https://www.getpostman.com/

Data types

All items in response/request are JSON objects, each field can be either simple type shown below or array/set of subitems.

In requests and responses following simple data types can be used:

• string - formatted as simple JSON string ("abc"). Empty string can be represented either as null or empty string. API always returns empty string as null. String parameters can be marked as required, that means null or empty string are not allowed for such strings and all required fields should be provided on creating new item.
• number - formatted as simple JSON number (12.3)
• boolean - formatted as simple JSON true or false (true)
• identifier - all identifiers are represented as GUIDs. Should be formatted as string
  with 36 characters: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX". Empty identifier can be
  represented either as null, empty string or "00000000-0000-0000-0000-000000000000"
  API always returns empty identifier as null.
• datetime - is represented in ISO 8601 Extended format "YYYY-MM-DDTHH:mm:ss.sssZ".
  T - delimiter char; milliseconds shown, but in this API wlll always be zero; timezone is always UTC ("Z" char). E.g. "2017-01-01T13:51:55.000Z".
  This format is native for Javascript and used in Date.toJSON(), Date.parse(). API also can receive dates in several other formats, full list of available incoming formats (but output is still always the same):
  • "YYYY-MM-DD"
  • "YYYY-MM-DDTHH:mm"
  • "YYYY-MM-DDTHH:mm:ss"
  • "YYYY-MM-DDTHH:mm:ss.sss"
  • "YYYY-MM-DDTHH:mm:ss.sssZ"
• image - in JSON formatted as base64, usually can be retrieved by direct link
• html_text - text with additional html tags, used to format that text. There are some differences with a valid html document
  • There is no <!DOCTYPE html> comment
  • Content should not be wrapped with <html> or <head> or <body> tags
  • Content should contains only one of these kind of nodes:
    • #text - contains plain text
    • <span> - can contain style attribute, which can contain these CSS declarations:
      • font-weight: bold - for bold text
      • font-style: italic - for italic text
      • text-decoration: underline - for underlined text
      • color: #FF0000 - text color. There can be any HEX-value color
    • <h1>, <h2>, <h3> - describes font size, can contains the same CSS declarations, as <span> node. Note, that headlines will be considered as NOT bold
    • <div> - describes paragraph with alignment. <div> should not contain another <div> inside it. Left-aligned text should NOT be wrapped with <div> tags. Alignment is set using style attribute, which contains one of two CSS declarations:
      • text-align: center - centered text
      • text-align: right - right-aligned text
    • <br/> - line break

Get list of items format

In current and next sections someitems in URL will describe clients, products, sales or any other item type.

Request: GET /someitems?fields=field_list[&filter1=value1&filter2=value2&..]

Get someitems with fields specified in fields parameter (required parameter).

Example of fields parameter:
fields=field1,field2,field_set3(subfield1,subfield2,..),..
If some field is array/set, use parentheses to describe subfields. If some subfield is also array/set, use parentheses again: e.g.
fields=id,name,history(date,name),relatives(name,history(date,name))

Each item has unique id (identifier). id can be used in API URL for GET/PUT/DELETE operations. id field is always returned,
no need to specify it in fields parameter.
If you specify fields parameter empty, only ids will be returned.

If filter values are set, filters applied. More details about filters will be provided in specific filter description.

For all items list there is one universal filter: ids - provide list of ids, separated by comma, only items with provided ids will be returned.

Response example:

[
        {
            "id": "246db366-061f-45ac-984d-de8050c045a1",
            "name": "Item 1",
            "type": "Simple",
            "color": "Red"
        },
        {
            "id": "905e5ff6-9d41-465b-aced-7ea81a7e2ee3",
            "name": "Item 2",
            "type": "Complex",
            "color": "Green"
        },
        {
            "id": "cfbb963e-3ceb-4764-b3f4-805f3a3e056b",
            "name": "Item 3",
            "type": "Simple",
            "color": "Yellow"
        }
]

Items in response are sorted either by field "name" or field "date" (if "name" not exists, any item has either "name" or "date" fields).

Get item by id format

Request: GET /someitems/{id}?fields=field_list

Get item with given id and fields specified in fields parameter (required parameter).

Example of fields parameter:
fields=field1,field2,field_set3(subfield1,subfield2,..),..
If some field is array/set, use parentheses to describe subfields. If some subfield is also array/set, use parentheses again: e.g.
fields=id,name,history(date,name),relatives(name,history(date,name))

id field is always returned, no need to specify it in fields parameter.

Response example:

{
    "id": "ecb3521a-3b50-4281-b947-34e7ca526b28",
    "name": "Item 1",
    "type": "Simple",
    "color": "Red"
}

Create new item format

Request: POST /someitems

{
    "name": "Item 4",
    "type": "Simple",
    "color": "Blue",
    "category": "8c98a00b-1526-4dc0-9968-008439a78019"
}

Not all fields should be specified - missing fields will be initialized with default values.

Response will return status 201 (not 200) and id of newly created item:

{
    "id": "1bfcf663-3f5d-4a86-8e0c-12c5ea34c137"
}

In some cases after item was created, some items fields except id needed. Making another GET request
(GET /someitems or GET /someitems/{id}) seems redundant. While making original request you can just describe
fields you want to receive in fields parameter (optional):

Request: POST /someitems?fields=name,type,color,category

{
    "name": "Item 4"
}

Response will look like:

{
    "id": "1bfcf663-3f5d-4a86-8e0c-12c5ea34c137",
    "name": "Item 4",
    "type": "Simple",
    "color": "",
    "category": null
}

Update item format

Request: PUT /someitems/{id}

{
    "type": "Complex"
}

Not all fields should be specified - missing fields will left field values unchanged.

In some cases after item was updated, some fields are needed. Making another GET request
(GET /someitems or GET /someitems/{id}) seems redundant. While making original request you can just describe
fields you want to receive in fields parameter (optional). Server always returns id of updated item
and fields of fields parameter if specified:

Request: PUT /someitems/{id}?fields=name,type,color,category

{
    "type": "Complex"
}

Response will look like:

{
    "id": "1bfcf663-3f5d-4a86-8e0c-12c5ea34c137",
    "name": "Item 1",
    "type": "Complex",
    "color": "Red",
    "category": null
}

Delete item format

Request: DELETE /someitems/{0}

(no body needed)

For DELETE requests JSON body is not needed and no body can be sent at all.

Response: status 204 (No content)

Operations with categories

Categories are present for several items types (products, services, groups, etc.), they are special
object types thus can be edited using special methods.

Each category 2 fields (except id):

• name - category name,
• parent - id of parent category.

Categories helps to make multi level hierarchies, like:

+ Top category (virtual)
    + Item 1
    + Category 1
        + Item 2
        + Subcategory 1
            + Item 3

Get list of categories format

Request: GET /someitems/categories?fields=field_list[&filter1=value1&filter2=value2&..]

Get categories with fields specified in fields parameter (required parameter). If filter values are set, filters applied.

Response example:

[
        {
            "id": "246db366-061f-45ac-984d-de8050c045a1",
            "name": "Subcategory 1",
            "parent": "8c98a00b-1526-4dc0-9968-008439a78019"
        },
        {
            "id": "5c8316ef-68fb-47d4-b99a-ef715a60bd16",
            "name": "Subcategory 2",
            "parent": "8c98a00b-1526-4dc0-9968-008439a78019"
        }
]

All categories in response are sorted by field "name".

Get category by id format

Request: GET /someitems/categories/{id}?fields=field_list

Get category with given id with fields specified in fields parameter (required parameter).

Response example:

{
    "id": "246db366-061f-45ac-984d-de8050c045a1",
    "name": "Subcategory 1",
    "parent": "8c98a00b-1526-4dc0-9968-008439a78019"
}

Create new category format

Same to creating new items:

Request: POST /someitems/categories

{
    "name": "Category 2",
    "parent": "8c98a00b-1526-4dc0-9968-008439a78019"
}

Not all fields should be specified - missing fields will be initialized with default values.

Response will return status 201 (not 200) and id of newly created category:

{
    "id": "1bfcf663-3f5d-4a86-8e0c-12c5ea34c137"
}

If some category fields except id is needed, you can just describe fields you want to receive in fields parameter (optional):

Request: POST /someitems/categories?fields=name,parent

{
    "name": "Category 2"
}

Response will look like:

{
    "id": "1bfcf663-3f5d-4a86-8e0c-12c5ea34c137",
    "name": "Category 2",
    "parent": null
}

Update category format

Request: PUT /someitems/categories/{id}

{
    "parent": null
}

Not all fields should be specified - missing fields will left field values unchanged.

Response: status 204 (No content)

If some category fields except id is needed, you can just describe fields you want to receive in fields parameter (optional):

Request: PUT /someitems/categories/{id}?fields=name,parent

{
    "parent": null
}

Response will look like:

{
    "id": "1bfcf663-3f5d-4a86-8e0c-12c5ea34c137",
    "name": "Category 2",
    "parent": null
}

Delete category format

Request: DELETE /someitems/categories/{0}

(no body needed)

For DELETE requests JSON body is not needed and no body can be sent at all.

Response: status 204 (No content)

Please mention, that removing category will remove all subcategories and all items in category and
all subcategories.

Get items with categories

Request: GET /someitems/tree[?fields=fields_list,categories_fields=categories_fields_list,empty_categories&filter1=value1&filter2=value2&..]

If some items are grouped in categories, in most cases most convenient will be to receive such items from API in
some sort of tree view. This request combine both items and categories and represent them in tree view:

1. Result root is "virtual" top category with empty id, name and parent. You can't update or delete this category.
2. Each category, including root, has two arrays: categories and items.
3. Items can be filtered using filters (same as for get items).
4. By default, empty categories (that has no subcategories or items) are not returned. You can force to return them,
   setting empty_categories in parameters.

Response will look like:

{
    "id": null,
    "name": "",
    "parent": null,
    "categories": [
        {
            "id": "8c98a00b-1526-4dc0-9968-008439a78019",
            "name": "Category 1",
            "parent": null,
            "categories": [
                {
                    "id": "5c8316ef-68fb-47d4-b99a-ef715a60bd16",
                    "name": "Subcategory 1",
                    "parent": "8c98a00b-1526-4dc0-9968-008439a78019",
                    "categories": [
                    ],
                    "items": [
                        {
                            "id": "cfbb963e-3ceb-4764-b3f4-805f3a3e056b",
                            "name": "Item 3",
                            "type": "Simple",
                            "color": "Yellow",
                            "category": "5c8316ef-68fb-47d4-b99a-ef715a60bd16"
                        }
                    ]
                }
            ],
            "items": [
                {
                    "id": "905e5ff6-9d41-465b-aced-7ea81a7e2ee3",
                    "name": "Item 2",
                    "type": "Complex",
                    "color": "Green",
                    "category": "8c98a00b-1526-4dc0-9968-008439a78019"
                ]
            }
        }
    ]
    "items": [
        {
            "id": "246db366-061f-45ac-984d-de8050c045a1",
            "name": "Item 1",
            "type": "Simple",
            "color": "Red",
            "category": null
        }
    ]
}

Categories in "categories" arrays are sorted by field "name", items in "items" array in response are sorted either by field "name" or "date" (if "name" not exists).

One moment to keep in mind with empty categories. Assume we have next structure:

+ Top category (virtual)
    + Item 1
    + Category 1
        + Item 2
        + Subcategory 1
            + Item 3
        + Empty subcategory 1
    + Category 2
        + Empty subcategory 2

Empty categories, as in example above can happen in two cases:

1. Someone add category in program and forgot to add items inside (or adding items in progress).
2. You use filters to filter some items and originally non-empty categories become empty with your filters.
   In most cases you don't need to receive empty categories, so API automatically filter empty categories and don't return them.
   So, tree structure above will look like:

+ Top category (virtual)
    + Item 1
    + Category 1
        + Item 2
        + Subcategory 1
            + Item 3

Empty subcategories 1 and 2 was not shown, Category 2 become empty and was not shown also.

If you need to receive empty categories, set parameter empty_categories and all categories will be preserved.

Getting/updating images

Difference between images and other data types are that images are binary data type. Thus it is non-optimal to
get/update them via JSON (using base64 for example). Also, receiving images inside JSON makes not so comfortable
to set IMG/PICTURE tags.

That's why getting/receiving images (client photos, employee photos, products pictures, etc.) are always separate methods.
But they all have same format.

Get image

To get image, use GET request one level deeper than object which image you want to get: for example, /items/{id}/photo.
Result will always be of content mime type image/jpeg, image/png or image/gif (if no image found, 404 error will be returned).

The most common problem with images is resizing them to specific size. Usually browser is capable of doing this,
but it is better to do that on server to decrease size of data transferred and increase speed. So, on getting images,
these 3 optional parameters can be provided (please note both width and height should be provided for resizing):

Parameter	Possible values	Description
width	integer	Width of resized image in pixels
height	integer	Height of resized image in pixels
resize	fit (default)/fit_center_transparent/stretch/crop	Type of operation in case proportions of original image will not match proportins of needed image.

List of possible resize values:

Value	Description
fit (default)	Image will be resized constraining proportions to fit into provided width & height. One of dimensions can be less than needed.
fit_center_transparent	Same as previous but if one of dimensions is less than needed, additional transparent rows/colums added to image to make width and height equal to needed
stretch	Image will be resized to needed width & height without constraining proportions (width and height will be exact as needed but image will be distorted)
crop	Image will be resized constraining proportions to such scale that one of dimensions is equal to needed while another is equal or bigger than needed. If second dimension is bigger, image will be cropped to match needed width and height. In this case proportions are constrained, image size equals to needed but part of image can be cropped (for example, original size 2000x1000, needed 100x100: first scale to 200x100 than crop left 50 and right 50 pixels).

In all cases scaling is done only for bigger images. Scaling is skipped if needed size is bigger than original (otherwise artefacts can be seen on image).

In some cases it is preferable to use API URL inside IMG/PICTURE tag, without using JavaScript to fetch image. But all image requests need access token in
Authorization header. So for getting image requests (and only for them) access token can be specified as additional parameter access_token in URL, thus
Authorization header not needed for such requests. Resulting URL can be easily inserted as src parameter of IMG tag.

A little about caching images: all images should be cached for 10 minutes, after that ETag can be used to check if image was changed or not.
If you use images inside IMG/PICTURE tags, browser do all this magic for you, but in case you get images from JavaScript or some other language,
please use Cache-Control and ETag headers to decrease traffic and increase speed of your application.

Update image

Updating image is very straightforward process.
Use same URL as for getting image but with PUT method.

Content should be image itself (mime types image/jpeg, image/png or image/gif are supported).
Mime type of an image will be defined by it's content, so Content-Type header will be ignored.

No parameters supported:
width, height and resize has no meaning: for each image type (client photo, product picture) there are custom max allowed size. If image is bigger,
it will be fitted in max allowed size.
access_token not allowed: access token should be passed as Authorization header.

There are three request types supported:

1) Sending binary data (recommended)

Images are binary files. So passing them 'as is' is recommended. This method requires least memory and time resources in comparison with the other methods

• Request header

  Authorization: Bearer 9c4068e2-c81f-4d70-ad31-8f627ed9bced
  

• Request body

  FF D8 FF E0 00 10 4A 46 49 46 00 01 01 00 00 01
  00 01 00 00 FF DB 00 43 00 05 03 04 04 04 03 05
  ...
  00 51 45 14 00 51 45 14 00 51 45 14 00 51 45 14
  01 FF D9
  

2) Sending base64 encoded image

Alternative way: use base64 encoding instead of pure binary data.
To send image as base64, Content-Transfer-Encoding header must be set to base64

• Request header

  Authorization: Bearer 9c4068e2-c81f-4d70-ad31-8f627ed9bced
  Content-Transfer-Encoding: base64
  

• Request body

  /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAUDBAQEAwUEBAQFBQUGBwwIBwcHBw8LCwkMEQ8SEhEPERETFhwXExQaFRERGCEYGh0dHx8fExciJCIeJBweHx7...AUUUUAFFFFABRRRQB/9k=
  

3) Sending resource url

You can also pass url, server will download image by itself.
To provide url, set Content-Type header to text/plain, then the request body will be considered as url.

Url should be well-formed in accordance with RFC 2396 and RFC 2732

• Request header

  Authorization: Bearer 9c4068e2-c81f-4d70-ad31-8f627ed9bced
  Content-Type: text/plain
  

• Request body

  https://some.image.url.com/img.png
  

To delete image, just send request without content (content length 0 bytes) or use DELETE method with same URL.

Result is 204 (No content) on success.

Scopes

Scopes describe which API is available for specific application (more about applications will be described later).

You can see needed scope in method description (only if Database or Client tokens used, otherwise scope is not appliable).

Scope	Description
full	Full read and write access to all salon/fitness database data.
clients_module	Online booking module: read services, employees, locations, free time; create and update client appointments.
reports	Read-only access for reports and analytics: appointments, sales, clients, services, products.
services_aggregator	Appointment aggregator: search and add clients by phone (no edit/delete); read services, employees and free time; create and update appointments without history access.
client_login	Login with client phone and SMS code (or create a new client). Available only for AI Helps products.

Scopes are chosen once when the application is registered and cannot be changed afterwards without contacting AI Helps support. An application may be granted one or more scopes. Token types client_access_token and application_access_token are assigned automatically by the token type (see Authorization) and are not selected at registration.

Request limits

The following limits apply to all API consumers:

• Up to 100 requests per second per IP address (overall).
• Up to 10 requests per second per IP address on /auth/* endpoints.
• Up to 5 concurrent requests per access token.
• Maximum request body size: 10 MB.
• Prefer batching work and avoiding polling list endpoints too frequently.
• Abusive traffic patterns may result in the source IP being blocked for up to 7 days.

If you exceed these limits, the API returns HTTP 429 (see 429 Too Many Requests below).

Errors

Depending on the request method, server return different HTTP status codes:

• GET:

  • 200 - OK: on success
  • 404 - Not Found: item not found by given id

• POST:

  • 201 - Created: on success
  • 202 - Accepted: for long-running requests

• PUT:

  • 200 - OK: on success if item returned
  • 202 - Accepted: for long-running requests
  • 204 - No content: on success if item not returned
  • 404 - Not Found: item not found by given id

• DELETE: 200 (OK)

  • 204 - No content: on success
  • 404 - Not Found: item not found by given id

• Common errors:

  • 400 - Bad Request: error in request parameters (bad parameters, required parameter not given)
  • 401 - Unauthorized: authorization required (if not specified) or failed (bad token, token expires etc.)
  • 403 - Forbidden: your scope does not allow running current API (check needed scope in documentation)
  • 409 - Conflict: your changes conflicts with data in database
  • 429 - Too Many Requests: server limits number of requests by ip for some methods (like authorization)
  • 500 - Internal Server Error: error happen on server while API method running (please write us at ag@aihelps.com)
  • 503 - Service Unavailable: server unavailable due to maintainance or some server problem (please try again later)

Success codes are 200 for GET, 201 for POST, 200/204 for PUT and 204 for DELETE requests.

In case of error (error codes >= 400) server response has next format (for all types of requests):

{
    "status": 401,
    "type": "INVALID",
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Unknown employee login or password",
    "details": "https://aihelpssoft.github.io/documentations/#error-INVALID"
}

Where:

• status: HTTP status code (described earlier)
• type: error type, if provided
• request: request id (you can use this id to get details from API developers via dev@aihelps.com)
• message: message for developer, describing problem
• details: link to documentation with more details

There are two types of errors:

1. errors like Bad Request which notifies that you use API in wrong way. These errors do not have type field, but provides detailed message. Such errors usually happens during development phase, thus developer see them and fix inplace. Such errors are: 400 Bad Request, 401 Unathorized, 403 Forbidden, 404 Not Found, 429 Too Many Requests, 500 Internal Server Error and 503 Service Unavailable. All of them can happen at any request.
2. errors that happens in production like invalid password while logging in or token expired. Such errors always have specific type and should be handled in code that uses API. Usually they have additional information in JSON parameters that helps to handle this error. You need to write code to manage them in production. They are: 400 Bad Request - APPOINTMENT_VALIDATION, 401 Unathorized - UNKNOWN, EXPIRED, INVALID and BLOCKED; 403 Forbidden - LICENSE; 409 Conflict - ALREADY_EXISTS and TIME_CONFLICT; 503 Service Unavailable - REMOTE_DATABASE, SMS, SMS_AUTH and SMS_BALANCE. From them 401 Unathorized - UNKNOWN, EXPIRED; 403 Forbidden - LICENSE; 503 Service Unavailable - REMOTE_DATABASE can happen at any request, other - only at specific requests (all such requests will be marked).

400 Bad Request

These errors means that your request is incorrect - not enough parameters, bad parameter type, failed validation and so on.

{
    "status": 400,
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Parameter `name` value should be equals or greater than zero",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/400-bad-request"
}

Can happen at any request.

400 Bad Request - APPOINTMENT_VALIDATION

These errors means some validation errors while changing appointment. List of these errors is long enough, details can be found in Appointments section. You can pass force=true parameter to ignore such validations.

{
    "status": 400,
    "type": "APPOINTMENT_VALIDATION",
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Validation error(s) while updating appointment",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/400-bad-request-appointment-validation",
    "validations":
    [
        {
            "id": "da77cb7c-5725-4afa-abf4-c097a9e9081a",
            "type": "SERVICE_PROFESSIONAL_CANT_PROVIDE_SERVICE",
            "service": "ced508d8-b4cf-498b-9893-a976a912ba21",
            "professional": "6b98745c-d72d-4831-b7cc-104449d17617"
        }
    ]
}

Can happen only at appointment insert/update endpoints.

401 Unathorized

These errors means some problems with authorization. If no type specified, it's usually common problem, that happens during development.

{
    "status": 401,
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Unknown authorization scheme: Basic",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/401-unathorized"
}

Can happen at any request.

401 Unathorized - UNKNOWN

These errors means some problems with authorization. type=UNKNOWN means that provided access token, refresh token, application id & password ot other requisites are unknown. There is no way to refresh token or continue session.

{
    "status": 401,
    "type": "UNKNOWN",
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Unknown access token: 3227f712-eb6c-4003-8260-ca70fcad50d1",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/401-unathorized-unknown"
}

Correct handling this error in production - treat session as logged out and redirect user to login page.

Can happen at any request.

401 Unathorized - EXPIRED

These errors means some problems with authorization. type=EXPIRED means that provided access token, auth id or other temporary access object is expired,

{
    "status": 401,
    "type": "EXPIRED",
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Access token expired",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/401-unathorized-expired"
}

Correct handling this error in production - silently refresh token, save new token and repeat original request.

Can happen at any request.

401 Unathorized - INVALID

These errors means some problems with authorization. type=INVALID means that during authorization process you provided wrong login/password, sms code or other authorization information.

{
    "status": 401,
    "type": "INVALID",
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Wrong provided sms code",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/401-unathorized-invalid"
}

Correct handling this error in production - notify user his credentials are invalid and provide possibility to enter credentials once more.

Can happen only at few authorization requests, such request will contain info about this error.

401 Unathorized - BLOCKED

These errors means some problems with authorization. type=BLOCKED means that during authorization process you overlimit attempts to enter password/sms code or other credentials and verification blocked for some time.

Additional parameter added unblockAfter, which contains number of seconds after which unblock occures and you can repeat attempts.

{
    "status": 401,
    "type": "BLOCKED",
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Can't check password: blocked for 10 minutes because 5 wrong passwords provided, left 124 seconds.",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/401-unathorized-blocked",
    "unblockAfter": 124
}

Another similar case: sms can be send only once a minute:

{
    "status": 401,
    "type": "BLOCKED",
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Sms verification code was sent recently, minimum interval is one minute between sending smses, 17 seconds left.",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/401-unathorized-blocked",
    "unblockAfter": 17
}

If you don't receive unblockAfter field, the only option for user is to start authentification process from start:

{
    "status": 401,
    "type": "BLOCKED",
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "auth_id becomes invalid after sending 20 wrong codes",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/401-unathorized-blocked"
}

Correct handling this error in production - notify user his credentials are invalid, wait for specified amount of time (if provided) and provide possibility to enter credentials once more. If unblockAfter not specified, start authorization process from beginning.

Can happen only at few authorization requests, such request will contain info about this error.

403 Forbidden

These errors means your scope does not allow running current API (check needed scope in documentation). If no type specified, it's usually problem with scopes and easily found during development process.

{
    "status": 403,
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Your scope (reports) does not allow running 'POST /clients'",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/403-forbidden"
}

Can happen at any request.

403 Forbidden - LICENSE

type=LICENSE means some problem with license, for example, "Licenses expired for all locations expired" or "This endpoint not allowed for your license type".

{
    "status": 403,
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Licenses expired for all locations expired",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/403-forbidden-license"
}

Correct handling this error in production - notify user that his license is finished, he should prolonge it until continue using product.

Can happen at any request.

404 Not Found

These errors means that either URL was not found or some object was not found by id, phone, name etc.

Additional parameters added object, type, value, which describes what object was not found.

object can be either "url" or item from database: "client", "employee", "appointment", etc.
type describes type of requisites used for search: "url" (for "url" only), "id", "phone", "email", "name", "code" (for database)
value value of type type used for search.

If URL was not found:

{
    "status": 404,
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "No API with URL POST /abc found",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/404-not-found",
    "object": "url",
    "type": "url",
    "value": "POST /abc"
}

If some object was not found:

{
    "status": 404,
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Client with id ccac7904-dbaa-4373-95c2-464031fdb533 not found",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/404-not-found",
    "object": "client",
    "type": "id",
    "value": "ccac7904-dbaa-4373-95c2-464031fdb533"
}

Can happen at any request.

409 Conflict - ALREADY_EXISTS

These errors means request could not be completed due to a conflict with the current state of the target resource. type=ALREADY_EXISTS means that object with provided parameters already exists.

Additional parameters added type, id, where:
itemType - type of item already exists
id of object already exists
where - list of conditions to be unique, used to find item

{
    "status": 409,
    "type": "ALREADY_EXISTS",
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Only one planned or confirmed appointment should exists for specified date + location + client + employee",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/409-conflict-already_exists",
    "itemType": "appointment",
    "id": "74e85faf-de73-4fe6-9530-3af1dd7c1b34",
    "where":
    {
        "date": "2020-01-01T00:00:00Z000",
        "location": "e0cd7be0-dcf1-4b49-b704-a5d2cbd59125",
        "client": "012b6f96-dbea-4e47-8c27-c474021c03f5",
        "employee": null,
        "state": "planned/confirmed"
    }
}

Correct handling this error in production - depending from endpoint, correct input data and make request once more if needed (in many cases item already exists and no need to repeat request).

Can happen only at few requests, such request will contain info about this error.

409 Conflict - TIME_CONFLICT

These errors means request could not be completed due to a conflict with the current state of the target resource. type=TIME_CONFLICT means that object can be saved on proposed time because it will conflict with already stored items.

Additional parameter added anotherItems, which is array of items, each containing:
id: id of object which changes raised time conflict (id of group lesson or aappointment service when changing itself, id of specific appointment service when changing appointment)
itemType: professional, hall, resource or appointment - type of conflicted resource
itemId: id of conflicted resource
objectType: another object, that use resource, possible values appointmentService, groupLesson, or nonWorkingTime (for professional only)
objectId: appointment service id or group lesson id
objectDescriptionId: object that describes conflicted object: appointment client or employee id for appointmentService, group id for groupLesson
objectStart: start of object (date and time)
objectDuration: object duration in minutes

{
    "status": 409,
    "type": "TIME_CONFLICT",
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Only one planned or confirmed appointment should exists for specified date + location + client + employee",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/409-conflict-time_conflict",
    "anotherItems":
    [
        {
            "id": "da77cb7c-5725-4afa-abf4-c097a9e9081a",
            "itemType": "professional",
            "itemId": "9d5437d2-b868-426c-a572-38d532d47987",
            "objectType": "appointmentService",
            "objectId": "e03ee732-2f5a-476f-afdb-0d53a16a072e",
            "objectDescriptionId": "4ac7591c-8811-430b-a3fb-d2e53f42c177",
            "objectStart": "2020-01-01T00:00:00Z000",
            "objectDuration": 120
        }
    ]
}

Correct handling this error in production - show received conflicts to user. If user really sure, most endpoints returning this error can be called once more with force=true parameter, ignoring this error.

Can happen only at few requests, such request will contain info about this error.

429 Too Many Requests

If you exceed the request limits, the API returns HTTP 429. Reduce request rate, avoid polling when webhooks are available, and retry after a short delay.

{
    "status": 429,
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Up to 100 requests per second allowed from one IP (try again soon)",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/429-too-many-requests"
}

Can happen at any request.

500 Internal Server Error

These errors usually means some server bug. Provide request identifier to development team to solve the bug.
Details of error are not shown for security reasons.

{
    "status": 500,
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Internal Server Error: error id 'a7dfb9a8-0383-4087-a1e6-606fc2bc714c'. You can use this id to get error details using api@aihelps.com",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/500-internal-server-error"
}

Can happen at any request.

503 Service Unavailable

These errors means some structural internal API problems, like problems with database. If no type specified, it's usually problems that can be solved only by AI Helps team in nearest future, you can do nothing with it.

{
    "status": 500,
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Service Unavailable (some of internal infrastructure is unavailable thus request can't be processed)",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/503-service-unavailable"
}

Can happen at any request.

503 Service Unavailable - REMOTE_DATABASE

In rare cases clients database is located not on AI Helps servers, but hosted on clients server. AI Helps can't guarantee such server will be always accessible.
type=REMOTE_DATABASE means API can't connect to clients database and process request (either server/database unavailable or wrong credentials stored in AI Helps for remote server). You can push clients by yourself to guarantee stable connection to their database.

{
    "status": 500,
    "type": "REMOTE_DATABASE",
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Remote database unavailable (client database located on other server is unavailable)",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/503-service-unavailable-remote_database"
}

Can happen at any request.

503 Service Unavailable - SMS

Clients usually have accounts in text messaging services to send smses to their clients. Some endpoints requires sending sms to proceed (like login via sms code). If some error happens during sending sms, errors with type=SMS wil be received. These errors are usually either problems with connectivity or situations when service changed their API and integration become invalid.

{
    "status": 503,
    "type": "SMS",
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Sending SMS: can't connect to sending service",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/503-service-unavailable-sms"
}

Correct handling this error in production - notify user message can't be sent due to problens with sending service and he should try once more in some time.

Can happen only at few requests, where sending sms is crucial, such request will contain info about this error.

503 Service Unavailable - SMS_AUTH

Clients usually have accounts in text messaging services to send smses to their clients. Some endpoints requires sending sms to proceed (like login via sms code). If during sending sms we discovered, that login, password or alpha name for sms sending service is incorrect, error with type=SMS_AUTH will happen. Contrary to error type=SMS this one can be easily fixed changing login/password/alpha name in program settings.

{
    "status": 503,
    "type": "SMS_AUTH",
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Sending SMS: wrong login/password",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/503-service-unavailable-sms_auth"
}

Correct handling this error in production - notify user message can't be sent due to wrong credentials and he should try once more in some time.

Can happen only at few requests, where sending sms is crucial, such request will contain info about this error.

503 Service Unavailable - SMS_BALANCE

Clients usually have accounts in text messaging services to send smses to their clients. Some endpoints requires sending sms to proceed (like login via sms code). If during sending sms we discovered, that no more credits left, error with type=SMS_BALANCE will happen. Contrary to error type=SMS this one can be easily fixed by client, making payment to sms sending service.

{
    "status": 503,
    "type": "SMS_BALANCE",
    "request": "a7dfb9a8-0383-4087-a1e6-606fc2bc714c",
    "message": "Sending SMS: out of money",
    "details": "https://aihelpssoft.github.io/documentations/#introduction/errors/503-service-unavailable-sms_balance"
}

Correct handling this error in production - notify user message can't be sent due to lack of money and he should try once more in some time.

Can happen only at few requests, where sending sms is crucial, such request will contain info about this error.

Change history

Here you can see history of changes in API and documentation.

Date	Description
2026-09-16	Documentation cleanup: scopes table, authorization annotations, webhooks rewrite, request limits, getting started, removed deprecated /common/employees, added missing endpoints
2026-08-19	clients: utm_campaign, utm_source, utm_medium fields added

Deprecated endpoints and fields

This section contains information about deprecated endpoints or fields in endpoints. We usually deprecate endpoints or fields if we propose some better alternative for such fields or resources. After deprecation published we give at least 3 months to API users to make corresponding changes in their code.
According to IETF standard, we return 3 headers in response in case endpoint is deprecated:

Deprecation: true
Sunset: [date]
Link: <[link to subsection in this section]>; rel="deprecation"

Link leads to subsection of this section, where more details and alternatives are described.

In case of deprecated field, we add one more non-standard header to make it easier to distinguish problem:

X-Deprecated-Field: [field]
Sunset date is date when we plan to remove endpoint or field. We will not remove endpont or field before that date, but can do it in any moment after date happens (thus in some cases endpoint/field can be valid for months more, but no guarantee).

{
    "access_token": "a71923bd-84c5-49a3-a7fb-a0825e26bbe4",
    "expires_at": "2017-06-01T00:00:00.000Z"
}

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "access_token": {
            "type": "string"
        },
        "expires_at": {
            "type": "string"
        }
    }
}

{
    "status": "pending"
}

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "status": {
            "enum": [
                "pending",
                "refused"
            ]
        }
    }
}

{
    "server": 1,
    "access_token": "a71923bd-84c5-49a3-a7fb-a0825e26bbe4",
    "database": "123456",
    "scope": [
        "full",
        "employee_login"
    ],
    "expires_at": "2017-06-01T00:00:00.000Z",
    "location": "a71923bd-84c5-49a3-a7fb-a08fbecc2be1"
}

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "server": {
            "type": "number"
        },
        "access_token": {
            "type": "string"
        },
        "database": {
            "type": "string"
        },
        "scope": {
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "expires_at": {
            "type": "string"
        },
        "refresh_token": {
            "type": "string"
        }
    }
}

{
    "auth_id": "91d14822-9150-4ba7-8adc-a20d9507a811"
}

{
    "server": 1,
    "access_token": "f4e6bdc1-58a9-4b2e-a06c-98ca194b2bf4",
    "expires_at": "2017-05-15T14:00:00.000Z",
    "refresh_token": "67d8f73c-52f8-45ad-a242-f3cb72ff79c2",
    "client_id": "d81dc7a7-879b-47a6-b98f-033558d5b074"
}

{
    "access_token": "a71923bd-84c5-49a3-a7fb-a0825e26bbe4",
    "expires_at": "2017-06-01T00:00:00.000Z",
    "refresh_token": "13baeeb8-ebe7-4751-86a6-5c960bfe1776"
}

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "access_token": {
            "type": "string"
        },
        "expires_at": {
            "type": "string"
        },
        "refresh_token": {
            "type": "string"
        }
    }
}

{
    "application_name": "Test application",
    "application_url": "testapp.com",
    "developer_name": "ABC Solutions",
    "contact_email": "dev@testapp.com",
    "redirection_endpoint": "testapp.com/app",
    "scope": "clients_module",
    "grant_access_url": "testapp.com/access/{database_code}"
}

{
    "id": "9245f5b4-d66e-483c-b7c4-fd55f9677bb3"
    "application_name": "Test application",
    "application_url": "testapp.com",
    "developer_name": "ABC Solutions",
    "contact_email": "dev@testapp.com",
    "application_id": "5330336c-143a-415a-b220-fc9932bc029d",
    "application_secret": "eb5cb7df-356e-475f-8afb-2eebe63a37bb",
    "redirection_endpoint": "testapp.com/app",
    "scope": "clients_module",
    "public": false,
    "countries": [],
    "grant_access_url": "testapp.com/access/{database_code}"
}

{
    "id": "9245f5b4-d66e-483c-b7c4-fd55f9677bb3"
    "application_name": "Test application",
    "application_url": "testapp.com",
    "developer_name": "ABC Solutions",
    "contact_email": "dev@testapp.com",
    "application_id": "5330336c-143a-415a-b220-fc9932bc029d",
    "application_secret": "eb5cb7df-356e-475f-8afb-2eebe63a37bb",
    "redirection_endpoint": "testapp.com/app",
    "scope": "clients_module",
    "public": false,
    "countries": [],
    "grant_access_url": "testapp.com/access/{database_code}"
}

{
    "application_name": "Test application",
    "application_url": "testapp.com",
    "developer_name": "ABC Solutions",
    "contact_email": "dev@testapp.com",
    "redirection_endpoint": "testapp.com/app",
    "scope": "clients_module"
}

{
    "id": "9245f5b4-d66e-483c-b7c4-fd55f9677bb3"
    "application_name": "Test application",
    "application_url": "testapp.com",
    "developer_name": "ABC Solutions",
    "contact_email": "dev@testapp.com",
    "application_id": "5330336c-143a-415a-b220-fc9932bc029d",
    "application_secret": "4809691c-0c3b-456f-aa3f-f3fca5b67010",
    "redirection_endpoint": "testapp.com/app",
    "scope": "clients_module",
    "public": false,
    "countries": [],
    "grant_access_url": "testapp.com/access/{database_code}"
}

[
    {
        "id": "3286cc03-3f88-4c8e-8d94-0af35b67beaf",
        "application_name": "Test application",
        "application_url": "testapp.com",
        "scope":
        [
            "clients_module",
        ],
        "public": true,
        "status": "none"
    },
    {
        "id": "7c527f8e-2551-40a0-b878-79dc3b16dd18",
        "application_name": "My first app",
        "application_url": "",
        "scope":
        [
            "full",
        ],
        "public": false,
        "status": "pending"
    }
]

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "application_name": {
            "type": "string"
        },
        "application_url": {
            "type": "string"
        },
        "scope": {
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "public": {
            "type": "boolean"
        },
        "status": {
            "enum": [
                "none",
                "pending",
                "granted",
                "refused"
            ]
        }
    }
}

{
    "tokens": [
        {
            "access_token": "d075dde6-7c91-4fc0-b1dd-b75b9c99a2f5",
            "expires_at": "2017-12-04T23:46:27Z",
            "refresh_token": "f9e96585-856f-4b48-95ca-9511c0ba5576",
            "type": "Database",
            "scope": [
                "clients",
                "sales"
            ],
            "database": "123456",
            "owner": null,
            "common_owner": null
        },
        {
            "access_token": "167b88db-9ebc-4ef6-a160-f466bd8f6548",
            "expires_at": "2017-08-15T17:28:55Z",
            "refresh_token": "aa742497-a3ae-4f76-9f07-53f93a96248a",
            "type": "Database",
            "scope": [
                "clients",
                "sales"
            ],
            "database": "456789",
            "owner": null,
            "common_owner": null
        },
        {
            "access_token": "a71923bd-84c5-49a3-a7fb-a0825e26bbe4",
            "expires_at": "2017-08-15T17:28:55Z",
            "refresh_token": "13baeeb8-ebe7-4751-86a6-5c960bfe1776",
            "type": "Application",
            "scope": null,
            "database": null,
            "owner": null,
            "common_owner": null
        }
    ]
}

[
    {
        "id": "2a0516e3-ddc9-432c-80e4-8d5f5e97cce3",
        "name": "Salon 123 New York",
        "category": "e2d21375-e772-4af2-8682-2b9460404b8e",
        "code": 594365,
        "city": "New York",
        "street": "1, Main av.",
        "phone": "+1 (555) 111 11 11",
        "timezone": "America/New_York",
        "active": true
    },
    {
        "id": "3fe0e240-d779-4a84-9e0c-825d9a6ddcc4",
        "name": "Salon 123 Los Angelos",
        "category": "e2d21375-e772-4af2-8682-2b9460404b8e",
        "code": 866423,
        "city": "Los Angelos",
        "street": "1, Main av.",
        "phone": "+1 (555) 222 22 22",
        "timezone": "America/Los_Angeles",
        "active": true
    },
    {
        "id": "843b8d24-2564-475f-8451-6ef25f2ccd18",
        "name": "Salon 123 Miami",
        "category": "ba41dfa4-4ce1-4328-aa91-3dfa68a4d5c1",
        "code": 168544,
        "city": "Miami",
        "street": "1, Main av.",
        "phone": "+1 (555) 333 33 33",
        "timezone": "America/New_York",
        "active": true
    }
]

{
    "id": "2dde3a05-c916-8d54-8432-7cce3f5e90ec",
    "name": "Salon 123 New York",
    "category": "e2d21375-e772-4af2-8682-2b9460404b8e",
    "code": 594365,
    "city": "New York",
    "street": "1, Main av.",
    "phone": "+1 (555) 111 11 11",
    "timezone": "America/New_York",
    "active": true
}

{
    "name": "Salon 123 New York",
    "city": "New York"
}

[
    {
        "id": "e2d21375-e772-4af2-8682-2b9460404b8e",
        "name": "Business class",
        "parent": null
    },
    {
        "id": "ba41dfa4-4ce1-4328-aa91-3dfa68a4d5c1",
        "name": "Luxury salons",
        "parent": null
    }
]

{
    "id": "ba41dfa4-4ce1-4328-aa91-3dfa68a4d5c1",
    "name": "Luxury salons",
    "parent": null
}

{
    "name": "Nail bars",
    "parent": null
}

{
    "id": "966a7cdc-ae92-4d6b-9605-9ab2dd74c776"
}

{
    "name": "Luxury boutiques",
    "parent": null
}

{
    "id": null,
    "name": "",
    "parent": null,
    "categories": [
        {
            "id": "e2d21375-e772-4af2-8682-2b9460404b8e",
            "name": "Business class",
            "parent": null,
            "categories": [],
            "items": [
                {
                    "id": "98d52d05-d1c9-40ec-8e62-7c43ce3a3f5e",
                    "name": "Salon 123 New York",
                    "category": "e2d21375-e772-4af2-8682-2b9460404b8e",
                    "code": 594365,
                    "city": "New York",
                    "street": "1, Main av.",
                    "phone": "+1 (555) 111 11 11"
                },
                {
                    "id": "3fe0e240-d779-4a84-9e0c-825d9a6ddcc4",
                    "name": "Salon 123 Los Angelos",
                    "category": "e2d21375-e772-4af2-8682-2b9460404b8e",
                    "code": 866423,
                    "city": "Los Angelos",
                    "street": "1, Main av.",
                    "phone": "+1 (555) 222 22 22"
                }
            ]
        },
        {
            "id": "ba41dfa4-4ce1-4328-aa91-3dfa68a4d5c1",
            "name": "Luxury salons",
            "parent": null,
            "categories": [],
            "items": [
                {
                    "id": "843b8d24-2564-475f-8451-6ef25f2ccd18",
                    "name": "Salon 123 Miami",
                    "category": "ba41dfa4-4ce1-4328-aa91-3dfa68a4d5c1",
                    "code": 168544,
                    "city": "Miami",
                    "street": "1, Main av.",
                    "phone": "+1 (555) 333 33 33"
                }
            ]
        }
    ],
    "items": []
}

[
    {
        "id": "88d6248d-e5e8-9c40-5296-bb10043eab27",
        "name": "John Brown",
        "firstname": "John",
        "middlename": "",
        "lastname": "Brown",
        "title": "",
        "gender": "male",
        "birthday": null,
        "location": "5382f467-a034-440c-bc7f-3dac932f8b99",
        "balance": 20.0,
        "bonus": 0,
        "card_number": [
            "127219432"
        ],
        "phone": [
            "+1 800 555 12 34"
        ],
        "email": [
            "john@gmail.com"
        ],
        "photo_exists": true,
        "photo": "https://api.aihelps.com/v1/images/696320/0b646349-e7be-4179-97bd-c7155caab991/photo",
        "postal_code": "",
        "city": "New York",
        "street": "",
        "building": "",
        "apartment": "",
        "first_visit": null,
        "last_visit": null,
        "feedback": null,
        "do_not_send_sms_notification": false,
        "do_not_send_sms_promotion": false,
        "do_not_send_email": false,
        "deposit_client": null,
        "referral_source": null,
        "referral_source_name": "",
        "status": "potential",
        "comments": "VIP status",
        "archive": false,
        "utm_campaign": "summer_sale",
        "utm_source": "google",
        "utm_medium": "cpc"
    },
    {
        "id": "6b663d27-90f5-4df0-a8c7-5924b9cd1c39",
        "name": "James Doe",
        "firstname": "John",
        "middlename": "",
        "lastname": "Brown",
        "title": "",
        "gender": "male",
        "birthday": null,
        "location": "5382f467-a034-440c-bc7f-3dac932f8b99",
        "balance": 0,
        "bonus": 0,
        "card_number": [],
        "phone": [
            "+1 800 555 48 15"
        ],
        "email": [],
        "photo_exists": false,
        "photo": null,
        "postal_code": "",
        "city": "New York",
        "street": "",
        "building": "",
        "apartment": "",
        "first_visit": null,
        "last_visit": null,
        "feedback": null,
        "do_not_send_sms_notification": false,
        "do_not_send_sms_promotion": false,
        "do_not_send_email": false,
        "deposit_client": null,
        "referral_source": "5382f467-a034-440c-bc7f-3dac9b2c8191",
        "referral_source_name": "flyers",
        "status", "potential",
        "comments": null,
        "archive": false,
        "professional": "5382f467-a034-440c-bc7f-3dac9b2c8191",
        "utm_campaign": "",
        "utm_source": "",
        "utm_medium": ""
    }
]

{
    "id": "88d6248d-e5e8-9c40-5296-bb10043eab27",
    "name": "John Brown",
    "firstname": "John",
    "middlename": "",
    "lastname": "Brown",
    "title": "",
    "gender": "male",
    "birthday": null,
    "location": "5382f467-a034-440c-bc7f-3dac932f8b99",
    "balance": 20.0,
    "bonus": 0,
    "card_number": [
        "127219432"
    ],
    "phone": [
        "+1 800 555 12 34"
    ],
    "email": [
        "john@gmail.com"
    ],
    "photo_exists": true,
    "photo": "https://api.aihelps.com/v1/images/696320/6b663d27-90f5-4df0-a8c7-5924b9cd1c48/photo",
    "postal_code": "",
    "city": "New York",
    "street": "",
    "building": "",
    "apartment": "",
    "first_visit": null,
    "last_visit": null,
    "feedback": null,
    "do_not_send_sms_notification": false,
    "do_not_send_sms_promotion": false,
    "do_not_send_email": false,
    "deposit_client": null,
    "referral_source": "5382f467-a034-440c-bc7f-3dac9b2c8191",
    "referral_source_name": "flyers",
    "status", "potential",
    "comments": "VIP status",
    "archive": false,
    "professional": "5382f467-a034-440c-bc7f-3dac9b2c8191",
    "utm_campaign": "summer_sale",
    "utm_source": "google",
    "utm_medium": "cpc"
}

{
    "firstname": "John",
    "lastname": " Doe",
    "phone": "+1 555 123 45 67",
    "email": "johndoe@gmail.com",
    "utm_campaign": "summer_sale",
    "utm_source": "google",
    "utm_medium": "cpc"
}

{
    "id": "cc903b03-ecaf-46d4-a030-bbfd1882f490"
}

{
    "phone": [
        "+1 555 123 45 67",
        "+1 555 123 45 68"
    ],
    "gender": "male",
    "utm_campaign": "summer_sale",
    "utm_source": "google",
    "utm_medium": "cpc"
}

[
    {
        "id": "3286cc03-3f88-4c8e-8d94-0af35b67beaf",
        "name": "VIP",
        "automatic": true
    }
]

{
    "id": "bf45f298-3073-413a-876f-0f17f45e374c",
    "name": "VIP",
    "automatic": false
}

{
    "name": "Gold",
}

{
    "id": "d8f244e8-f84d-4c21-b674-90135978216d",
    "name": "Gold",
    "automatic": false
}

{
    "name": "Gold",
}

{
    "id": "d8f244e8-f84d-4c21-b674-90135978216d",
    "name": "Gold",
    "automatic": false
}

[
    {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "date": "2019-01-15T10:30:00.000Z",
        "eventType": "Updated",
        "fieldName": "Phone",
        "fieldNameConvert": "Phone",
        "employeeName": "John Doe",
        "tableName": "client",
        "fieldBeforeConvert": "+1 555 111 11 11",
        "fieldAfterConvert": "+1 555 222 22 22",
        "event": 2,
        "gender": "Male"
    }
]

[
    {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "date": "2019-01-15T10:30:00.000Z",
        "eventType": "Updated",
        "fieldName": "Phone",
        "fieldNameConvert": "Phone",
        "employeeName": "John Doe",
        "tableName": "client",
        "fieldBeforeConvert": "+1 555 111 11 11",
        "fieldAfterConvert": "+1 555 222 22 22",
        "event": 2,
        "gender": "Male"
    }
]

[
    {
        "id": "88d4b305-e198-f02c-2743-cca9390c6d9b",
        "from_client": "88d3d8a4-0629-b0ce-5798-55163380117b",
        "to_client": "88d3d8a4-0629-b0ce-5798-55160e7a6556",
        "relation_type": "Child"
    },
    {
        "id": "88d4c84b-9562-db0e-25f9-8879620d3872",
        "from_client": "88d4c84b-59f2-fb62-25f9-88792de3ea4c",
        "to_client": "88d4c84b-1b9b-3e06-25f9-88796d89a302",
        "relation_type": "Sib"
    }
]

[
    {
        "id": "88d4b305-e198-f02c-2743-cca9390c6d9b",
        "from_client": "88d3d8a4-0629-b0ce-5798-55163380117b",
        "to_client": "88d3d8a4-0629-b0ce-5798-55160e7a6556",
        "relation_type": "Child"
    }
]

[
    {
        "id": "88d39450-0c81-9ca8-139a-8eb20176600b",
        "date": "1799-12-31T00:00:00.000Z",
        "duration": 60,
        "professional": null,
        "professional_name": "",
        "professional_photo_exists": false,
        "paid": true,
        "items": [
            {
                "id": "88d37eed-6689-d1d3-6bee-ad104a954fc2",
                "name": "Premium",
                "type": "Card",
                "picture": null,
                "quantity": 1,
                "sum": 5000,
                "sale_id": "88d39450-0c81-9ca8-139a-8eb20176600b"
            }
        ],
        "client_notified": true,
        "feedback": {
            "date": "2018-04-28T21:20:11.000Z",
            "ratings": 5,
            "text": "well"
        }
    },
    {
        "id": "88d395df-bf56-7e8e-5278-6cf9506aaed4",
        "date": "2016-06-16T16:00:00.000Z",
        "duration": 35,
        "professional": "88d37eed-0e73-b347-6bee-ad103615dee1",
        "professional_name": "John Doe",
        "professional_photo_exists": false,
        "paid": true,
        "items": [
            {
                "id": "88d37ef2-5930-80f8-6bee-ad1021c2fd8b",
                "name": "Epilation",
                "type": "Service",
                "picture": null,
                "quantity": 1,
                "sum": 0,
                "sale_id": "88d395df-bf56-7e8e-5278-6cf9506aaed4"
            }
        ],
        "client_notified": true,
        "feedback": null
    },
    {
        "id": "88d39eaf-dc0e-ac59-1be5-be5c762ccc88",
        "date": "2016-06-27T20:00:00.000Z",
        "duration": 60,
        "professional": "88d37eeb-cb47-bedb-6bee-ad1048f62926",
        "professional_name": "",
        "professional_photo_exists": false,
        "paid": false,
        "items": [],
        "client_notified": true,
        "feedback": null
    }
]

[
    {
        "id": "9802426c-92a8-41f0-976b-5a643e3df6f2",
        "firstname": "John",
        "public": true,
        "date": "2019-01-01T10:00:00.000Z",
        "text": "cool professional",
        "ratings": {
            "a860ecab-e030-48c8-aeba-4c5a419db8c5": 2,
            "bd603053-a530-4cd0-b67e-db84192a8ea9": 5
        }
    },
    {
        "id": "4a87cc85-a4a2-40fa-930c-c0833ef24251",
        "firstname": "Bob",
        "public": true,
        "date": "2019-01-01T10:00:00.000Z",
        "text": "cool professional",
        "ratings": {
            "c680c43d-07ad-4050-959d-279a2c1ba272": 2,
            "32006adc-a269-43b8-83e7-6fb5ca5bbef3": 5
        }
    }
]

{
    "id": "4a87cc85-a4a2-40fa-930c-c0833ef24253",
    "firstname": "John",
    "public": true,
    "date": "2019-01-01T10:00:00.000Z",
    "text": "cool professional",
    "ratings": {
        "a860ecab-e030-48c8-aeba-4c5a419db8c5": 2,
        "bd603053-a530-4cd0-b67e-db84192a8ea9": 5
    }
}

{
    "public": false,
    "text": "bad"
}

[
    {
        "id": "3286cc03-3f88-4c8e-8d94-0af35b67beaf",
        "name": "advertising",
        "archive": false
    },
    {
        "id": "3286cc03-3f88-4c8e-8d94-0af35b67b1a1",
        "name": "flyers",
        "archive": false
    }
]

{
    "id": "3286cc03-3f88-4c8e-8d94-0af35b67b1a1",
    "name": "flyers",
    "archive": false
}

{
    "name": "flyers"
}

{
    "id": "d8f244e8-f84d-4c21-b674-90135978216d",
    "name": "flyers"
}

{
    "name": "flyers"
}

{
    "id": "d8f244e8-f84d-4c21-b674-90135978216d",
    "name": "flyers"
}

[
    {
        "id": "88d4d8c0-3830-5b07-7bfe-b80f0650b9f3",
        "name": "John Brown",
        "firstname": "John",
        "middlename": "",
        "lastname": "Brown",
        "title": "",
        "phone": [
            "+1 (800) 555 55 55"
        ],
        "email": [
            "bob@yahoo.com"
        ],
        "gender": "male",
        "photo_exists": true,
        "photo": "https://api.aihelps.com/v1/images/696320/0b646349-e7be-4179-97bd-c7155caab923/photo",
        "positions": [
            "88d354c4-6ac5-a672-6996-67b22cd78ca6",
            "88d4d8c4-512f-7d55-7bfe-b80f413625dc"
        ],
        "roles": "professional",
        "permissions": [],
        "archive": false,
        "public": true,
        "services": [],
        "schedules": [
            {
                "location": "88d45ef0-6e9a-cfb6-0b47-d56566fe9691",
                "schedule": null,
                "start_day": "1800-01-01T00:00:00.000Z"
            },
            {
                "location": "88d45ef0-6e9a-cfb6-0b47-d56566fe9691",
                "schedule": null,
                "start_day": "1799-12-31T00:00:00.000Z"
            }
        ],
        "address": {
            "city": "New York",
            "street": "17 Avenue",
            "building": "17",
            "apartment": "",
            "postal_code": "222204"
        },
        "feedback_count": 5,
        "average_feedback_rating": 4.5,
        "prepaymentRequired": false,
        "comments": "Employee1",
        "commentsPlainText": "Employee1"
    },
    {
        "id": "72fcfa1d-65a7-404c-8c41-7449265ae489",
        "name": "John Doe",
        "firstname": "John",
        "middlename": "",
        "lastname": "Doe",
        "title": "",
        "phone": [
            "+1 (800) 555 55 55"
        ],
        "email": [
            "John@yahoo.com"
        ],
        "gender": "male",
        "photo_exists": true,
        "photo": "https://api.aihelps.com/v1/images/696320/0b646349-e7be-4179-97bd-c7155cacb21/photo",
        "positions": [
            "ff13c4c4-6ac5-a672-6996-67bc2bd7aca1",
            "88d4d8c4-512f-7d55-7bfe-b80f4136c5aa"
        ],
        "roles": "professional",
        "permissions": [],
        "archive": false,
        "public": true,
        "services": [],
        "schedules": [
            {
                "location": "88d45ef0-6e9a-cfb6-0b47-d56566fe9691",
                "schedule": null,
                "start_day": "1800-01-01T00:00:00.000Z"
            }
        ],
        "address": {
            "city": "Los Angelos",
            "street": "West lane",
            "building": "11",
            "apartment": "",
            "postal_code": "03065"
        },
        "feedback_count": 5,
        "average_feedback_rating": 4,
        "prepaymentRequired": false,
        "comments": "Employee2",
        "commentsPlainText": "Employee2"
    }
]

{
    "id": "432c41bf-0cd7-4f13-83dd-a0c26ce29143",
    "name": "John Brown",
    "firstname": "John",
    "middlename": "",
    "lastname": "Brown",
    "title": "",
    "phone": [
        "+1 (800) 555 55 55"
    ],
    "email": [
        "Doe@yahoo.com"
    ],
    "gender": "male",
    "photo_exists": true,
    "photo": "https://api.aihelps.com/v1/images/696320/0b646349-e7be-4179-97bd-c7155caab91a/photo",
    "positions": [
        "ff13c4c4-6ac5-a672-6996-67bc2bd7aca1",
        "88d4d8c4-512f-7d55-7bfe-b80f4136c5aa"
    ],
    "roles": "professional",
    "permissions": [],
    "archive": false,
    "public": true,
    "services": [],
    "schedules": [
        {
            "location": "88d45ef0-6e9a-cfb6-0b47-d56566fe9691",
            "schedule": null,
            "start_day": "1800-01-01T00:00:00.000Z"
        }
    ],
    "address": {
        "city": "New York",
        "street": "17 Avenue",
        "building": "17",
        "apartment": "",
        "postal_code": "222204"
    },
    "feedback_count": 5,
    "average_feedback_rating": 4.5,
    "prepaymentRequired": false,
    "comments": "Employee2",
    "commentsPlainText": "Employee2"
}

{
    "firstname": "John",
    "middlename": "",
    "lastname": "Brown",
    "phone": [
        "+1 555 1234567"
    ],
    "email": "bobcorn@gmail.com"
}

{
    "id": "475a20e9-23ef-40ce-b2c4-c7dbcf230ebb"
}

{
    "phone": [
        "+1 555 1234567",
        "+1 555 1234568"
    ],
    "gender": "male",
    "archive": false
}

{
    "professional": "8f423935-ff1b-4a61-b0a9-8533ce5e683a"
}

[
    {
        "id": "04c5daec-2c11-4ce9-b00d-03a03d50356f",
        "name": "Stylists",
        "role": "professional",
        "permissions": [
            "",
            ""
        ]
    },
    {
        "id": "e28ebfd0-f847-4c3f-b2a1-07f4257b0764"
    }
]

{
    "id": "432c41bf-0cd7-4f13-83dd-a0c26ce29143",
}

{
    "receiver_email": "example@employeeemail.com"
}

{
    "database_code": "123456",
    "employee_id": "432c41bf-0cd7-4f13-83dd-a0c26ce29143"
}

[
    {
        "id": "88d896df-3918-481e-67b4-7a05342314b1",
        "name": "test",
        "type": "weekdays",
        "byWorkshifts": false,
        "workDaysCount": 1,
        "freeDaysCount": 1,
        "workStart": "",
        "workEnd": "",
        "workShift": 0,
        "oddActive": false,
        "evenActive": false,
        "oddStart": "",
        "oddEnd": "",
        "oddShift": 0,
        "evenStart": "",
        "evenEnd": "",
        "evenShift": 0,
        "weekSchedule": [
            {
                "weekDay": "monday",
                "timeFrom": "09:00",
                "timeTo": "18:00"
            },
            {
                "weekDay": "tuesday",
                "timeFrom": "09:00",
                "timeTo": "18:00"
            },
            {
                "weekDay": "wednesday",
                "timeFrom": "09:00",
                "timeTo": "18:00"
            },
            {
                "weekDay": "thursday",
                "timeFrom": "09:00",
                "timeTo": "18:00"
            },
            {
                "weekDay": "friday",
                "timeFrom": "09:00",
                "timeTo": "18:00"
            },
            {
                "weekDay": "saturday",
                "timeFrom": "09:00",
                "timeTo": "09:00"
            },
            {
                "weekDay": "sunday",
                "timeFrom": "09:00",
                "timeTo": "09:00"
            }
        ],
        "weekShifts": [
            {
                "weekDay": "monday",
                "dayShift": 0
            },
            {
                "weekDay": "tuesday",
                "dayShift": 0
            },
            {
                "weekDay": "wednesday",
                "dayShift": 0
            },
            {
                "weekDay": "thursday",
                "dayShift": 0
            },
            {
                "weekDay": "friday",
                "dayShift": 0
            },
            {
                "weekDay": "saturday",
                "dayShift": 0
            },
            {
                "weekDay": "sunday",
                "dayShift": 0
            }
        ]
    },
    {
        "id": "88d83a01-d791-95f8-2a0a-8b443dd6ebb3",
        "name": "Eveeryday",
        "type": "weekdays",
        "byWorkshifts": false,
        "workDaysCount": 1,
        "freeDaysCount": 1,
        "workStart": "",
        "workEnd": "",
        "workShift": 0,
        "oddActive": false,
        "evenActive": false,
        "oddStart": "",
        "oddEnd": "",
        "oddShift": 0,
        "evenStart": "",
        "evenEnd": "",
        "evenShift": 0,
        "weekSchedule": [
            {
                "weekDay": "monday",
                "timeFrom": "00:00",
                "timeTo": "00:00"
            },
            {
                "weekDay": "tuesday",
                "timeFrom": "00:00",
                "timeTo": "00:00"
            },
            {
                "weekDay": "wednesday",
                "timeFrom": "00:00",
                "timeTo": "00:00"
            },
            {
                "weekDay": "thursday",
                "timeFrom": "00:00",
                "timeTo": "00:00"
            },
            {
                "weekDay": "friday",
                "timeFrom": "00:00",
                "timeTo": "00:00"
            },
            {
                "weekDay": "saturday",
                "timeFrom": "00:00",
                "timeTo": "00:00"
            },
            {
                "weekDay": "sunday",
                "timeFrom": "00:00",
                "timeTo": "00:00"
            }
        ],
        "weekShifts": [
            {
                "weekDay": "monday",
                "dayShift": 0
            },
            {
                "weekDay": "tuesday",
                "dayShift": 0
            },
            {
                "weekDay": "wednesday",
                "dayShift": 0
            },
            {
                "weekDay": "thursday",
                "dayShift": 0
            },
            {
                "weekDay": "friday",
                "dayShift": 0
            },
            {
                "weekDay": "saturday",
                "dayShift": 0
            },
            {
                "weekDay": "sunday",
                "dayShift": 0
            }
        ]
    }
]

{
    "id": "88d83a01-d791-95f8-2a0a-8b443dd6ebb3",
    "name": "Everyday",
    "type": "weekdays",
    "byWorkshifts": false,
    "workDaysCount": 1,
    "freeDaysCount": 1,
    "workStart": "",
    "workEnd": "",
    "workShift": 0,
    "oddActive": false,
    "evenActive": false,
    "oddStart": "",
    "oddEnd": "",
    "oddShift": 0,
    "evenStart": "",
    "evenEnd": "",
    "evenShift": 0,
    "weekSchedule": [
        {
            "weekDay": "monday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "tuesday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "wednesday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "thursday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "friday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "saturday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "sunday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        }
    ],
    "weekShifts": [
        {
            "weekDay": "monday",
            "dayShift": 0
        },
        {
            "weekDay": "tuesday",
            "dayShift": 0
        },
        {
            "weekDay": "wednesday",
            "dayShift": 0
        },
        {
            "weekDay": "thursday",
            "dayShift": 0
        },
        {
            "weekDay": "friday",
            "dayShift": 0
        },
        {
            "weekDay": "saturday",
            "dayShift": 0
        },
        {
            "weekDay": "sunday",
            "dayShift": 0
        }
    ]
}

{
    "name": "two by two",
    "type": "nAfterM",
    "byWorkshifts": false,
    "workDaysCount": 2,
    "freeDaysCount": 2,
    "workStart": "09:00",
    "workEnd": "18:00",
    "workShift": 0,
    "oddActive": false,
    "evenActive": false,
    "oddStart": "",
    "oddEnd": "",
    "oddShift": 0,
    "evenStart": "",
    "evenEnd": "",
    "evenShift": 0,
    "weekSchedule": [
        {
            "weekDay": "monday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "tuesday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "wednesday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "thursday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "friday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "saturday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "sunday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        }
    ],
    "weekShifts": [
        {
            "weekDay": "monday",
            "dayShift": 0
        },
        {
            "weekDay": "tuesday",
            "dayShift": 0
        },
        {
            "weekDay": "wednesday",
            "dayShift": 0
        },
        {
            "weekDay": "thursday",
            "dayShift": 0
        },
        {
            "weekDay": "friday",
            "dayShift": 0
        },
        {
            "weekDay": "saturday",
            "dayShift": 0
        },
        {
            "weekDay": "sunday",
            "dayShift": 0
        }
    ]
}

{
    "id": "88d89784-6cc2-7e6a-6668-ee372dd3d84b",
    "name": "two by two",
    "type": "nAfterM",
    "byWorkshifts": false,
    "workDaysCount": 2,
    "freeDaysCount": 2,
    "workStart": "09:00",
    "workEnd": "18:00",
    "workShift": 0,
    "oddActive": false,
    "evenActive": false,
    "oddStart": "08:00",
    "oddEnd": "21:00",
    "oddShift": 0,
    "evenStart": "08:00",
    "evenEnd": "21:00",
    "evenShift": 0,
    "weekSchedule": [
        {
            "weekDay": "monday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "tuesday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "wednesday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "thursday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "friday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "saturday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "sunday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        }
    ],
    "weekShifts": [
        {
            "weekDay": "monday",
            "dayShift": 0
        },
        {
            "weekDay": "tuesday",
            "dayShift": 0
        },
        {
            "weekDay": "wednesday",
            "dayShift": 0
        },
        {
            "weekDay": "thursday",
            "dayShift": 0
        },
        {
            "weekDay": "friday",
            "dayShift": 0
        },
        {
            "weekDay": "saturday",
            "dayShift": 0
        },
        {
            "weekDay": "sunday",
            "dayShift": 0
        }
    ]
}

{
    "name": "two by two 2",
    "type": "nAfterM",
    "byWorkshifts": false,
    "workDaysCount": 2,
    "freeDaysCount": 2,
    "workStart": "09:00",
    "workEnd": "18:00",
    "workShift": 0,
    "oddActive": false,
    "evenActive": false,
    "oddStart": "08:00",
    "oddEnd": "21:00",
    "oddShift": 0,
    "evenStart": "08:00",
    "evenEnd": "21:00",
    "evenShift": 0,
    "weekSchedule": [
        {
            "weekDay": "monday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "tuesday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "wednesday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "thursday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "friday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "saturday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "sunday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        }
    ],
    "weekShifts": [
        {
            "weekDay": "monday",
            "dayShift": 0
        },
        {
            "weekDay": "tuesday",
            "dayShift": 0
        },
        {
            "weekDay": "wednesday",
            "dayShift": 0
        },
        {
            "weekDay": "thursday",
            "dayShift": 0
        },
        {
            "weekDay": "friday",
            "dayShift": 0
        },
        {
            "weekDay": "saturday",
            "dayShift": 0
        },
        {
            "weekDay": "sunday",
            "dayShift": 0
        }
    ]
}

{
    "id": "88d89784-6cc2-7e6a-6668-ee372dd3d84b",
    "name": "two by two 2",
    "type": "nAfterM",
    "byWorkshifts": false,
    "workDaysCount": 2,
    "freeDaysCount": 2,
    "workStart": "09:00",
    "workEnd": "18:00",
    "workShift": 0,
    "oddActive": false,
    "evenActive": false,
    "oddStart": "08:00",
    "oddEnd": "21:00",
    "oddShift": 0,
    "evenStart": "08:00",
    "evenEnd": "21:00",
    "evenShift": 0,
    "weekSchedule": [
        {
            "weekDay": "monday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "tuesday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "wednesday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "thursday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "friday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "saturday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        },
        {
            "weekDay": "sunday",
            "timeFrom": "00:00",
            "timeTo": "00:00"
        }
    ],
    "weekShifts": [
        {
            "weekDay": "monday",
            "dayShift": 0
        },
        {
            "weekDay": "tuesday",
            "dayShift": 0
        },
        {
            "weekDay": "wednesday",
            "dayShift": 0
        },
        {
            "weekDay": "thursday",
            "dayShift": 0
        },
        {
            "weekDay": "friday",
            "dayShift": 0
        },
        {
            "weekDay": "saturday",
            "dayShift": 0
        },
        {
            "weekDay": "sunday",
            "dayShift": 0
        }
    ]
}

{
    "type": "nAfterM",
    "byWorkshifts": false,
    "workDaysCount": 1,
    "freeDaysCount": 1,
    "workStart": "00:00",
    "workEnd": "00:01"
},
{
    "type": "evenOdd",
    "oddActive": true,
    "evenActive": true,
    "oddStart": "00:10",
    "oddEnd": "00:20",
    "evenStart": "01:00",
    "evenEnd": "02:00"
},
{
    "type": "weekdays",
    "weekSchedule": [
        {
            "weekDay": "monday",
            "timeFrom": "10:00",
            "timeTo": "12:00"
        },
        {
            "weekDay": "tuesday",
            "timeFrom": "10:00",
            "timeTo": "12:00"
        },
        {
            "weekDay": "wednesday",
            "timeFrom": "10:00",
            "timeTo": "12:00"
        },
        {
            "weekDay": "thursday",
            "timeFrom": "10:00",
            "timeTo": "14:00"
        },
        {
            "weekDay": "sunday",
            "timeFrom": "11:00",
            "timeTo": "12:00"
        }
    ]
}

{
    "name": "Mo 09:00-18:00, We-Th 09:00-18:00, Sa 09:00-18:00"
}

{
    "88d4b305-e198-f02c-2743-cca9390c631c": {
        "2019-01-01": [
            "10:00",
            "10:30",
            "11:00"
        ],
        "2019-01-02": [
            "10:00",
            "10:30",
            "11:00"
        ]
    },
    "023276a7-7ca9-45c9-9f9c-b536ec20315b": {
        "2019-01-01": [
            "10:00",
            "10:30",
            "11:00"
        ],
        "2019-01-02": [
            "10:00",
            "10:30",
            "11:00"
        ]
    }
}

[
    {
        "id": "246db366-061f-45ac-984d-de8050c045a1",
        "location": "3635cbcf-54e0-4d23-aeb5-6ecb58abb129",
        "predefinedSchedule": "04c5daec-2c11-4ce9-b00d-03a03d50356f",
        "employee": "0997d37b-49fc-4bd6-8c24-0fbcacb141a7",
        "scheduleStartDate": "2019-01-01T00:00:00.000Z"
    }
]

{
    "id": "246db366-061f-45ac-984d-de8050c045a1",
    "location": "3635cbcf-54e0-4d23-aeb5-6ecb58abb129",
    "predefinedSchedule": "04c5daec-2c11-4ce9-b00d-03a03d50356f",
    "employee": "0997d37b-49fc-4bd6-8c24-0fbcacb141a7",
    "scheduleStartDate": "2019-01-01T00:00:00.000Z"
}

[
    {
        "id": "905e5ff6-9d41-465b-aced-7ea81a7e2ee3",
        "location": "3635cbcf-54e0-4d23-aeb5-6ecb58abb129",
        "hall": "e1462348-3bda-45fe-b9bc-a2ee8df8b60e",
        "employee": "0997d37b-49fc-4bd6-8c24-0fbcacb141a7",
        "dateStart": "2019-01-15T09:00:00.000Z",
        "dateEnd": "2019-01-15T18:00:00.000Z"
    }
]

{
    "id": "905e5ff6-9d41-465b-aced-7ea81a7e2ee3",
    "location": "3635cbcf-54e0-4d23-aeb5-6ecb58abb129",
    "hall": "e1462348-3bda-45fe-b9bc-a2ee8df8b60e",
    "employee": "0997d37b-49fc-4bd6-8c24-0fbcacb141a7",
    "dateStart": "2019-01-15T09:00:00.000Z",
    "dateEnd": "2019-01-15T18:00:00.000Z"
}

[
    {
        "id": "cfbb963e-3ceb-4764-b3f4-805f3a3e056b",
        "location": "3635cbcf-54e0-4d23-aeb5-6ecb58abb129",
        "employee": "0997d37b-49fc-4bd6-8c24-0fbcacb141a7",
        "date": "2019-01-20T00:00:00.000Z"
    }
]

{
    "id": "cfbb963e-3ceb-4764-b3f4-805f3a3e056b",
    "location": "3635cbcf-54e0-4d23-aeb5-6ecb58abb129",
    "employee": "0997d37b-49fc-4bd6-8c24-0fbcacb141a7",
    "date": "2019-01-20T00:00:00.000Z"
}

{
    "id": "38dc3801-a1aa-40b8-8e58-f00d81bc0019",
    "firstname": "John",
    "lastname": "Doe",
    "password": true,
    "databases": [
        {
            "id": 123456,
            "name": "ABC Salon NY",
            "locations": [
                {
                    "id": "96e7b6c7-1813-4719-8676-544b1488637e",
                    "name": "ABC Salon NY Brooklyn",
                    "city": "New York",
                    "address": "2818 Foster Ave",
                    "active": true
                },
                {
                    "id": "d80e7df4-fa60-4c78-9f27-3f6cca49accb",
                    "name": "ABC Salon NY Manhatten",
                    "city": "New York",
                    "address": "",
                    "active": false
                },
                {
                    "id": "7eb575ee-59b1-471d-87c5-ca10ac15712d",
                    "name": "ABC Salon NY Queens",
                    "city": "New York",
                    "address": "",
                    "active": true
                }
            ]
        },
        {
            "id": 123457,
            "name": "ABC Salon LA",
            "locations": [
                {
                    "id": "8642faa0-d830-44cc-ac9a-add946edad65",
                    "name": "ABC Salon LA Downtown",
                    "city": "Los Angelos",
                    "address": "",
                    "active": false
                },
                {
                    "id": "abc21c49-47b5-4f80-b5e7-f3d61338984e",
                    "name": "ABC Salon LA Hollywood",
                    "city": "Los Angelos",
                    "address": "",
                    "active": true
                }
            ]
        },
        {
            "id": 123458,
            "name": "ABC Salon SF",
            "locations": [
                {
                    "id": "de491f53-0969-4d08-9b04-b6d58b44f610",
                    "name": "ABC Salon SF Bay Area",
                    "city": "San Fransisco",
                    "address": "",
                    "active": false
                }
            ]
        }
    ],
    "contacts": [
        {
            "type": "phone",
            "contact": "18005550123",
            "verified": true
        },
        {
            "type": "email",
            "contact": "a@gmail.com",
            "verified": false
        }
    ]
}

{
    "firstname": "Johnathan",
    "lastname": "Brown",
    "password": "VemTVHy9SrRg"
}

{
    "database": 123456,
    "location": "2dabff53-0e22-463f-98e4-d37b501c6545"
}

{
    "access_token": "d075dde6-7c91-4fc0-b1dd-b75b9c99a2f5",
    "expires_at": "2016-08-12T14:18:27.000Z",
    "refresh_token": "f9e96585-856f-4b48-95ca-9511c0ba5576",
    "server": 1,
    "database": 123456,
    "location": "2dabff53-0e22-463f-98e4-d37b501c6545",
    "scope":
    [
        "clients",
        "sales"
    ],
    "possibilities":
    [
        "Clients",
        "Services",
        "Products",
        "Salary",
        ...
    ],
    "user": "38dc3801-a1aa-40b8-8e58-f00d81bc0019",
    "employee": "94467e16-13a6-4159-bde8-f78326fa4c52"
}

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "access_token": {
            "type": "string"
        },
        "expires_at": {
            "type": "string"
        },
        "refresh_token": {
            "type": "string"
        },
        "server": {
            "type": "number"
        },
        "database": {
            "type": "string"
        },
        "location": {
            "type": "string"
        },
        "scope": {
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "possibilities": {
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "user": {
            "type": "string"
        },
        "employee": {
            "type": "string"
        }
    }
}

[
    {
        "id": "88d60be6-fba7-49c0-3d28-066a5cb5f1b9",
        "name": "Compex",
        "description": "Complex service",
        "descriptionPlainText": "Complex service",
        "duration": 60,
        "gender": "both",
        "price_currency": "UAH",
        "no_professional_price": null,
        "category": "c867e139-a433-4e4a-885d-ab81489ad488",
        "picture": null,
        "pictureUrl": "",
        "public": true,
        "location_prices": [
            {
                "location": "88d60c1b-5ddd-a723-0312-ba0507cf5e92",
                "position": "88660d76-a42f-442f-ba18-4378888e430f",
                "price": 200,
                "staff_price": 0
            }
        ],
        "halls": null,
        "resources": null,
        "color": "White",
        "article": null,
        "barcode": null,
        "with_assistant": false,
        "service_by_time": false,
        "department": "b45c58a6-a0ba-4ee2-afda-cb0d6e7102b4",
        "archive": false
    }
]

{
    "id": "88d60be6-fba7-49c0-3d28-066a5cb5f1b9",
    "name": "Compex",
    "description": "Complex service",
    "descriptionPlainText": "Complex service",
    "duration": 60,
    "gender": "both",
    "price_currency": "UAH",
    "no_professional_price": null,
    "category": "f1c36ed0-ee16-4a8a-83df-ad7e4e3d2a03",
    "picture": "0b646349-e7be-4179-97bd-c7155caab923",
    "pictureUrl": "https://api.aihelps.com/v1/images/696320/0b646349-e7be-4179-97bd-c7155caab923/picture",
    "public": true,
    "location_prices": 
    [
        {
            "location": "00df7375-1e7b-44d8-be05-a7777e79b012",
            "position": "d68cab7f-443f-454c-80f1-8ba8498cb0a4",
            "price": 200,
            "staff_price": null
        }
    ],
    "halls": 
    [
        "d68cab7f-443f-454c-80f1-8ba8498cb0a4"
    },
    "resources": 
    [
        "a2f61d84-e659-472b-8a1a-284721c979ae"
    ],
    "color": "#ffffff",
    "article": "234124",
    "barcode": "12351",
    "with_assistant": false,
    "service_by_time": false,
    "department": "88d6133e-95ba-3880-77ef-874262f695de",
    "archive": false
}

{
    "name": "Compex",
    "description": "",
    "duration": 60,
    "gender": "both",
    "price_currency": "UAH",
    "no_professional_price": null,
    "category": "88d60be9-abea-1947-53d9-31154749b7b9",
    "picture": null,
    "public": true,
    "location_prices": 
    [
        {
            "location": "8660d976-a42f-442f-ba18-4378888e430f",
            "position": "b45c58a6-a0ba-4ee2-afda-cb0d6e7102b4",
            "price": 200,
            "staff_price": 0
        }
    ],
    "halls": 
    [
        "d68cab7f-443f-454c-80f1-8ba8498cb0a4"
    },
    "resources": 
    [
        "a2f61d84-e659-472b-8a1a-284721c979ae"
    ],
    "color": "White",
    "article": "125122",
    "barcode": "51251",
    "with_assistant": false,
    "service_by_time": false,
    "department": "88d6133e-95ba-3880-77ef-874262f695de"
}

{
    "id": "cc903b03-ecaf-46d4-a030-bbfd1882f490"
}

[
    "name": "Compex",
    "description": "",
    "duration": 60
]

[
    {
        "id": "c9edc51c-a95a-4f9c-84fd-67022b957d79",
        "name": "Haircuts",
        "parent": null,
        "picture": "529e4dca-c512-44ac-aa53-d2470a5ced91",
        "archive": false
    },
    {
        "id": "ddc757ab-3656-489b-b414-c8f872c967fe",
        "name": "Manicure",
        "parent": null,
        "picture": "893453b0-fd84-450a-bc2f-42083272d792",
        "archive": false
    }
]