ListOk CRM API

Авторизация

Запрос авторизации

Если используется виджет

Конфигурация кнопки
<div id="listok-oauth-widget"
     data-oauth-url="https://yourdomain.listokcrm.ru/oauth/authorize"
     data-client-id="9e3db8c5-02f5-4fa8-a8cf-d19fa69f1ec5"
     data-redirect-uri="https://yourapp.com"
     data-button-text="Авторизоваться через ListOk CRM"
     data-button-classes="btn custom-btn-class">
</div>

<script src="https://yourdomain.listokcrm.ru/assets/public/js/listok-oauth-widget.js"></script>

Если используется переход по ссылке

https://yourdomain.listokcrm.ru/oauth/authorize?client_id=9e3db2d2-4054-43bb-bdd4-554d55da27a0&redirect_uri=http%3A%2F%2Fsomesite.test&response_type=code&scope&state=qwerqwerqwerqwerqwerqwerqwerqwerqwerqwer

Обмен кода на токен

curl --request POST \
    "https://yourdomain.listokcrm.ru/oauth/token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"grant_type\": \"authorization_code\",
    \"client_id\": \"your_app_client_id\",
    \"client_secret\": \"your_app_client_secret\",
    \"redirect_uri\": \"your_app_redirect_uri\",
    \"code\": \"code\"
}"

Обновление токена

curl --request POST \
    "https://yourdomain.listokcrm.ru/oauth/token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"grant_type\": \"refresh_token\",
    \"client_id\": \"your_app_client_id\",
    \"client_secret\": \"your_app_client_secret\",
    \"refresh_token\": \"your_refresh_token\",
    \"scope\": ""
}"

Changelog

Просмотр


## v2.08.15 (26.01.2026)
### ✨ Новое
## Добавлены новые методы
- Создать занятие
- Редактировать занятие
- Удалить занятие
- Получить данные филиала
- Получить список филиалов
- Редактировать филиал
- Создать филиал
- Удалить филиал
- Получить данные зала
- Получить список залов
- Создать зал
- Удалить зал
- Редактировать зал
- Получить данные направления
- Получить список направлений
- Создать направление
- Удалить направление
- Редактировать направление
- Создать группу
- Удалить группу
- Редактировать группу
- Список преподавателей 

## v2.07.15 (26.01.2026)
### 🐞 Исправления
- 1. Исправлена ошибка в методе "Отменить запись клиента на занятие"

Абонементы

Получить список абонементов

GET

https://yourdomain.listokcrm.ru

/api/external/v2/passes

requires authentication

Метод предоставляет данные о всех неудаленных абонементах в аккаунте

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Query Parameters

page

integer

required

Страница

Example:

Response Fields

pass_id

required

ID абонемента

name

string

required

Название абонемента

description

string

Описание абонемента

admit_number

Количество занятий

valid_for_days

Срок действия (дни)

valid_for_months

Срок действия (месяцы)

freeze_times

Количество заморозок

freeze_days

Количество дней заморозки

pass_type

required

ID типа абонемента. 1 - базовый, 2 - безлимитный, 3 - пробный

price

integer

required

Стоимость абонемента

allowed_times

Ограничение по времени. Доступные дни для записи

disabled_days

Ограничение по времени. Недоступные дни для записи

allow_buying_pass_mobile

Разрешена ли покупка через мобильное приложение

allow_buying_pass_online

Разрешена ли покупка онлайн

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/passes?page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "pass_id": 1,
            "name": "Абонемент на 10 занятий",
            "description": "",
            "admit_number": 12,
            "valid_for_days": 31,
            "valid_for_months": 0,
            "freeze_times": 100,
            "freeze_days": 100,
            "pass_type": 1,
            "price": 2000,
            "allowed_times": [],
            "disabled_days": [],
            "allow_buying_pass_mobile": 0,
            "allow_buying_pass_online": 0
        },
        {
            "pass_id": 1,
            "name": "Абонемент на 10 занятий",
            "description": "",
            "admit_number": 12,
            "valid_for_days": 31,
            "valid_for_months": 0,
            "freeze_times": 100,
            "freeze_days": 100,
            "pass_type": 1,
            "price": 2000,
            "allowed_times": [],
            "disabled_days": [],
            "allow_buying_pass_mobile": 0,
            "allow_buying_pass_online": 0
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Группы

Получить список групп

GET

https://yourdomain.listokcrm.ru

/api/external/v2/groups

requires authentication

Метод предоставляет данные о всех неудаленных группах

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Query Parameters

page

integer

required

Страница

Example:

Response Fields

group_id

required

ID группы

name

string

required

Название группы

description

string

Описание группы

duration

integer

required

Продолжительность занятия (в минутах)

teacher_name

Имя основного преподавателя

second_teacher_name

Имя второго преподавателя

color

string

Цвет группы

video

string

Ссылка на видео группы

photo

string

Ссылка на фото группы

max_attendance_limit

Максимальное количество людей на занятии. 0 - неограниченно

office_name

Название филиала

office_id

ID филиала

created_at

string

required

Дата и время создания

updated_at

string

required

Дата и время последнего обновления

deleted_at

Дата удаления (если группа удалена)

disable_online_listing

Отключить онлайн-запись

private_group

Приватная группа

group_type_name

Название направления

group_type_id

ID направления

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/groups?page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "group_id": 1,
            "name": "Тестовая группа",
            "duration": 60,
            "teacher_name": "Только Ассистент",
            "second_teacher_name": null,
            "color": "",
            "max_attendance_limit": 3,
            "office_name": "Основной 1",
            "office_id": 0,
            "created_at": "2016-01-27T15:46:51.000000Z",
            "updated_at": "2025-12-05T02:05:46.000000Z",
            "deleted_at": null,
            "private_group": 0,
            "group_type_name": "Нпрвлне",
            "group_type_id": 3,
            "description": "<div><span style=\"font-size:12.0pt;font-family:&quot;Times New Roman&quot;,serif\">Тренировка по плаванию проходит с персональным тренером. Подходит &nbsp;для детей в возрасте от 2 месяцев до 8 лет.&nbsp; Все тренеры &nbsp;имеют большой&nbsp; профессиональный опыт.&nbsp;&nbsp;</span><span style=\"font-size:12.0pt;font-family:&quot;Times New Roman&quot;,serif\">Продолжительность занятия - 30 мин.</span></div>",
            "disable_online_listing": 0,
            "video": "",
            "photo": ""
        },
        {
            "group_id": 1,
            "name": "Тестовая группа",
            "duration": 60,
            "teacher_name": "Только Ассистент",
            "second_teacher_name": null,
            "color": "",
            "max_attendance_limit": 3,
            "office_name": "Основной 1",
            "office_id": 0,
            "created_at": "2016-01-27T15:46:51.000000Z",
            "updated_at": "2025-12-05T02:05:46.000000Z",
            "deleted_at": null,
            "private_group": 0,
            "group_type_name": "Нпрвлне",
            "group_type_id": 3,
            "description": "<div><span style=\"font-size:12.0pt;font-family:&quot;Times New Roman&quot;,serif\">Тренировка по плаванию проходит с персональным тренером. Подходит &nbsp;для детей в возрасте от 2 месяцев до 8 лет.&nbsp; Все тренеры &nbsp;имеют большой&nbsp; профессиональный опыт.&nbsp;&nbsp;</span><span style=\"font-size:12.0pt;font-family:&quot;Times New Roman&quot;,serif\">Продолжительность занятия - 30 мин.</span></div>",
            "disable_online_listing": 0,
            "video": "",
            "photo": ""
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Создать группу

POST

https://yourdomain.listokcrm.ru

/api/external/v2/groups

requires authentication

Метод позволяет создать группу

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Body Parameters

name

string

Название направления.

Example:

Фитнес

duration

integer

Длительность, мин.

Example:

group_type_id

integer

Направление.

Example:

123

office_id

integer

Филиал.

Example:

123

employee_id

integer

Преподаватель. Если авторизованный пользователь преподаватель - будет автоматически установлен текущий авторизованный преподаватель.

Example:

123

employee_id2

integer

Второй Преподаватель.

Example:

123

max_attendance_limit

integer

Максимальное количество людей на занятии. 0 - без лимита.

Example:

admission_cost

integer

Стоимость посещения, которая будет выставляться по умолчанию на занятиях данной группы при оплате посещений без абонемента.

Example:

allow_event_creation_for_any_employee

string

Создание занятий данной группы преподавателем. 1 - любым, 0 - только преподавателями данной группы.

Example:

display_online

string

Отображать в онлайн-сервисах.

Example:

description

string

Описание для онлайн расписания.

Example:

Фитнес

disable_online_listing

string

Онлайн запись на занятие.

Example:

video

string

Видео обложка (с YouTube или VK Видео) для онлайн расписания (ссылка).

Example:

https://vkvideo.ru/video-123_123

Response Fields

group_id

required

ID группы

name

string

required

Название группы

description

string

Описание группы

duration

integer

required

Продолжительность занятия (в минутах)

teacher_name

Имя основного преподавателя

second_teacher_name

Имя второго преподавателя

color

string

Цвет группы

video

string

Ссылка на видео группы

photo

string

Ссылка на фото группы

max_attendance_limit

Максимальное количество людей на занятии. 0 - неограниченно

office_name

Название филиала

office_id

ID филиала

created_at

string

required

Дата и время создания

updated_at

string

required

Дата и время последнего обновления

deleted_at

Дата удаления (если группа удалена)

disable_online_listing

Отключить онлайн-запись

private_group

Приватная группа

group_type_name

Название направления

group_type_id

ID направления

Example request:

curl --request POST \
    "https://yourdomain.listokcrm.ru/api/external/v2/groups" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"name\": \"Фитнес\",
    \"duration\": 60,
    \"group_type_id\": 123,
    \"office_id\": 123,
    \"employee_id\": 123,
    \"employee_id2\": 123,
    \"max_attendance_limit\": 0,
    \"admission_cost\": 0,
    \"allow_event_creation_for_any_employee\": 1,
    \"display_online\": 1,
    \"description\": \"Фитнес\",
    \"disable_online_listing\": 0,
    \"video\": \"https:\\/\\/vkvideo.ru\\/video-123_123\"
}"

Example response:

{
    "group_id": 1,
    "name": "Тестовая группа",
    "duration": 60,
    "teacher_name": "Только Ассистент",
    "second_teacher_name": null,
    "color": "",
    "max_attendance_limit": 3,
    "office_name": "Основной 1",
    "office_id": 0,
    "created_at": "2016-01-27T15:46:51.000000Z",
    "updated_at": "2025-12-05T02:05:46.000000Z",
    "deleted_at": null,
    "private_group": 0,
    "group_type_name": "Нпрвлне",
    "group_type_id": 3,
    "description": "<div><span style=\"font-size:12.0pt;font-family:&quot;Times New Roman&quot;,serif\">Тренировка по плаванию проходит с персональным тренером. Подходит &nbsp;для детей в возрасте от 2 месяцев до 8 лет.&nbsp; Все тренеры &nbsp;имеют большой&nbsp; профессиональный опыт.&nbsp;&nbsp;</span><span style=\"font-size:12.0pt;font-family:&quot;Times New Roman&quot;,serif\">Продолжительность занятия - 30 мин.</span></div>",
    "disable_online_listing": 0,
    "video": "",
    "photo": ""
}

Получить данные группы

GET

https://yourdomain.listokcrm.ru

/api/external/v2/groups/{groupId}

requires authentication

Метод предоставляет данные о конкретной группе по ID

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

groupId

integer

required

ID группы

Example:

Response Fields

group_id

required

ID группы

name

string

required

Название группы

description

string

Описание группы

duration

integer

required

Продолжительность занятия (в минутах)

teacher_name

Имя основного преподавателя

second_teacher_name

Имя второго преподавателя

color

string

Цвет группы

video

string

Ссылка на видео группы

photo

string

Ссылка на фото группы

max_attendance_limit

Максимальное количество людей на занятии. 0 - неограниченно

office_name

Название филиала

office_id

ID филиала

created_at

string

required

Дата и время создания

updated_at

string

required

Дата и время последнего обновления

deleted_at

Дата удаления (если группа удалена)

disable_online_listing

Отключить онлайн-запись

private_group

Приватная группа

group_type_name

Название направления

group_type_id

ID направления

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/groups/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "group_id": 1,
    "name": "Тестовая группа",
    "duration": 60,
    "teacher_name": "Только Ассистент",
    "second_teacher_name": null,
    "color": "",
    "max_attendance_limit": 3,
    "office_name": "Основной 1",
    "office_id": 0,
    "created_at": "2016-01-27T15:46:51.000000Z",
    "updated_at": "2025-12-05T02:05:46.000000Z",
    "deleted_at": null,
    "private_group": 0,
    "group_type_name": "Нпрвлне",
    "group_type_id": 3,
    "description": "<div><span style=\"font-size:12.0pt;font-family:&quot;Times New Roman&quot;,serif\">Тренировка по плаванию проходит с персональным тренером. Подходит &nbsp;для детей в возрасте от 2 месяцев до 8 лет.&nbsp; Все тренеры &nbsp;имеют большой&nbsp; профессиональный опыт.&nbsp;&nbsp;</span><span style=\"font-size:12.0pt;font-family:&quot;Times New Roman&quot;,serif\">Продолжительность занятия - 30 мин.</span></div>",
    "disable_online_listing": 0,
    "video": "",
    "photo": ""
}

Редактировать группу

PUT

PATCH

https://yourdomain.listokcrm.ru

/api/external/v2/groups/{groupId}

requires authentication

Метод позволяет редактировать группу

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

groupId

integer

required

Example:

Body Parameters

name

string

Название направления.

Example:

Фитнес

duration

integer

Длительность, мин.

Example:

group_type_id

integer

Направление.

Example:

123

employee_id

integer

Example:

123

employee_id2

integer

Второй Преподаватель.

Example:

123

max_attendance_limit

integer

Максимальное количество людей на занятии. 0 - без лимита.

Example:

admission_cost

integer

Example:

allow_event_creation_for_any_employee

string

Создание занятий данной группы преподавателем. 1 - любым, 0 - только преподавателями данной группы.

Example:

display_online

string

Отображать в онлайн-сервисах.

Example:

description

string

Описание для онлайн расписания.

Example:

Фитнес

disable_online_listing

string

Онлайн запись на занятие.

Example:

video

string

Видео обложка (с YouTube или VK Видео) для онлайн расписания (ссылка).

Example:

https://vkvideo.ru/video-123_123

Response Fields

group_id

required

ID группы

name

string

required

Название группы

description

string

Описание группы

duration

integer

required

Продолжительность занятия (в минутах)

teacher_name

Имя основного преподавателя

second_teacher_name

Имя второго преподавателя

color

string

Цвет группы

video

string

Ссылка на видео группы

photo

string

Ссылка на фото группы

max_attendance_limit

Максимальное количество людей на занятии. 0 - неограниченно

office_name

Название филиала

office_id

ID филиала

created_at

string

required

Дата и время создания

updated_at

string

required

Дата и время последнего обновления

deleted_at

Дата удаления (если группа удалена)

disable_online_listing

Отключить онлайн-запись

private_group

Приватная группа

group_type_name

Название направления

group_type_id

ID направления

Example request:

curl --request PUT \
    "https://yourdomain.listokcrm.ru/api/external/v2/groups/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"name\": \"Фитнес\",
    \"duration\": 60,
    \"group_type_id\": 123,
    \"employee_id\": 123,
    \"employee_id2\": 123,
    \"max_attendance_limit\": 0,
    \"admission_cost\": 0,
    \"allow_event_creation_for_any_employee\": 1,
    \"display_online\": 1,
    \"description\": \"Фитнес\",
    \"disable_online_listing\": 0,
    \"video\": \"https:\\/\\/vkvideo.ru\\/video-123_123\"
}"

Example response:

{
    "group_id": 1,
    "name": "Тестовая группа",
    "duration": 60,
    "teacher_name": "Только Ассистент",
    "second_teacher_name": null,
    "color": "",
    "max_attendance_limit": 3,
    "office_name": "Основной 1",
    "office_id": 0,
    "created_at": "2016-01-27T15:46:51.000000Z",
    "updated_at": "2025-12-05T02:05:46.000000Z",
    "deleted_at": null,
    "private_group": 0,
    "group_type_name": "Нпрвлне",
    "group_type_id": 3,
    "description": "<div><span style=\"font-size:12.0pt;font-family:&quot;Times New Roman&quot;,serif\">Тренировка по плаванию проходит с персональным тренером. Подходит &nbsp;для детей в возрасте от 2 месяцев до 8 лет.&nbsp; Все тренеры &nbsp;имеют большой&nbsp; профессиональный опыт.&nbsp;&nbsp;</span><span style=\"font-size:12.0pt;font-family:&quot;Times New Roman&quot;,serif\">Продолжительность занятия - 30 мин.</span></div>",
    "disable_online_listing": 0,
    "video": "",
    "photo": ""
}

Удалить группу

DELETE

https://yourdomain.listokcrm.ru

/api/external/v2/groups/{groupId}

requires authentication

Метод позволяет удалить группу по ID

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

groupId

integer

required

ID группы

Example:

Example request:

curl --request DELETE \
    "https://yourdomain.listokcrm.ru/api/external/v2/groups/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Залы

Получить список залов

GET

https://yourdomain.listokcrm.ru

/api/external/v2/rooms

requires authentication

Метод предоставляет данные о всех неудаленных залах

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Query Parameters

page

integer

required

Страница

Example:

Response Fields

room_id

required

ID зала

office_id

required

ID филиала

name

string

required

Название зала

description

string

Описание зала

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/rooms?page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "room_id": 2,
            "office_id": 2,
            "name": "room 2",
            "description": ""
        },
        {
            "room_id": 2,
            "office_id": 2,
            "name": "room 2",
            "description": ""
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Создать зал

POST

https://yourdomain.listokcrm.ru

/api/external/v2/rooms

requires authentication

Метод позволяет создать зал

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Body Parameters

name

string

Название зала.

Example:

Зал для фитнеса

office_id

integer

Филиал. Невозможно изменить после создания зала.

Example:

description

string

Описание.

Example:

Зал для фитнеса

Response Fields

room_id

required

ID зала

office_id

required

ID филиала

name

string

required

Название зала

description

string

Описание зала

Example request:

curl --request POST \
    "https://yourdomain.listokcrm.ru/api/external/v2/rooms" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"name\": \"Зал для фитнеса\",
    \"office_id\": 1,
    \"description\": \"Зал для фитнеса\"
}"

Example response:

{
    "room_id": 2,
    "office_id": 2,
    "name": "room 2",
    "description": ""
}

Получить данные зала

GET

https://yourdomain.listokcrm.ru

/api/external/v2/rooms/{roomId}

requires authentication

Метод предоставляет данные о конкретном зале по ID

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

roomId

integer

required

ID зала

Example:

Response Fields

room_id

required

ID зала

office_id

required

ID филиала

name

string

required

Название зала

description

string

Описание зала

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/rooms/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "room_id": 2,
    "office_id": 2,
    "name": "room 2",
    "description": ""
}

Редактировать зал

PUT

PATCH

https://yourdomain.listokcrm.ru

/api/external/v2/rooms/{roomId}

requires authentication

Метод позволяет редактировать зал

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

roomId

integer

required

ID зала

Example:

Body Parameters

name

string

Название зала.

Example:

Зал для фитнеса

description

string

Описание.

Example:

Зал для фитнеса

Response Fields

room_id

required

ID зала

office_id

required

ID филиала

name

string

required

Название зала

description

string

Описание зала

Example request:

curl --request PUT \
    "https://yourdomain.listokcrm.ru/api/external/v2/rooms/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"name\": \"Зал для фитнеса\",
    \"description\": \"Зал для фитнеса\"
}"

Example response:

{
    "room_id": 2,
    "office_id": 2,
    "name": "room 2",
    "description": ""
}

Удалить зал

DELETE

https://yourdomain.listokcrm.ru

/api/external/v2/rooms/{roomId}

requires authentication

Метод позволяет удалить зал по ID

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

roomId

integer

required

ID зала

Example:

Example request:

curl --request DELETE \
    "https://yourdomain.listokcrm.ru/api/external/v2/rooms/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Занятия

Получить данные о всех занятиях на конкретную дату или период.

GET

https://yourdomain.listokcrm.ru

/api/external/v2/events

requires authentication

Метод производит поиск всех не удаленных занятий по всем филиалам. Поиск необходимо запускать с параметром date, формат даты должен быть ГГГГ-ММ-ДД

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Query Parameters

date

string

Дата занятия. Если указана, то не будут работать from и to.

Example:

2024-01-01

from

string

Дата занятия. Начало периода.

Example:

2024-01-01

string

Дата занятия. Конец периода. Период ограничен 7 днями.

Example:

2024-01-10

includes

string

Загрузка дополнительных сущностей. В объект занятия можно включить: записи, посещения, лист ожидания.

Example:

listings,admissions,queue

Response Fields

event_id

ID занятия

description

Описание занятия

type

string

Тип занятия

week_day

День недели

date

string

Дата занятия

end_date_time

Дата и время окончания

start_time

Время начала

end_time

Время окончания

created_at

string

Дата и время создания

updated_at

string

Дата и время последнего обновления

deleted_at

integer

Дата удаления (если удалено)

display_online

Отображение занятия в онлайн сервисах

places_left

Количество свободных мест на занятии. Есть только при загрузке 1 занятия

group_id

ID группы

event_comment

Комментарий к занятию

teacher_name

Имя основного преподавателя

second_teacher_name

Имя второго преподавателя

room_name

Название зала

group_name

Название группы

max_attendance_limit

Максимальное количество людей на занятии. 0 - неограниченно

group_type_name

Название направления

office_name

Название филиала

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/events?date=2024-01-01&from=2024-01-01&to=2024-01-10&includes=listings%2Cadmissions%2Cqueue" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "event_id": 9,
            "description": null,
            "type": "copy",
            "week_day": 0,
            "date": "2023-10-09",
            "end_date_time": null,
            "start_time": "07:00",
            "end_time": "08:00",
            "admission_coef": 1,
            "created_at": "2023-10-09T07:13:40.000000Z",
            "updated_at": "2023-10-09T07:13:40.000000Z",
            "deleted_at": 0,
            "display_online": 1,
            "group_id": 1,
            "event_comment": "",
            "teacher_name": null,
            "second_teacher_name": null,
            "room_name": "Тренажерный Зал 1",
            "group_name": "Тестовая группа",
            "max_attendance_limit": 3,
            "group_type_name": "Нпрвлне",
            "office_name": "Основной 1"
        },
        {
            "event_id": 9,
            "description": null,
            "type": "copy",
            "week_day": 0,
            "date": "2023-10-09",
            "end_date_time": null,
            "start_time": "07:00",
            "end_time": "08:00",
            "admission_coef": 1,
            "created_at": "2023-10-09T07:13:40.000000Z",
            "updated_at": "2023-10-09T07:13:40.000000Z",
            "deleted_at": 0,
            "display_online": 1,
            "group_id": 1,
            "event_comment": "",
            "teacher_name": null,
            "second_teacher_name": null,
            "room_name": "Тренажерный Зал 1",
            "group_name": "Тестовая группа",
            "max_attendance_limit": 3,
            "group_type_name": "Нпрвлне",
            "office_name": "Основной 1"
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Создать занятие

POST

https://yourdomain.listokcrm.ru

/api/external/v2/events

requires authentication

Метод позволяет создать занятие

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Body Parameters

office_id

integer

Филиал.

Example:

123

group_id

integer

Группа.

Example:

123

room_id

integer

Зал.

Example:

123

contact_id

integer

ID преподавателя, либо 0 - нет преподавателя, -1 - по умолчанию из группы.

Example:

123

contact_id2

integer

ID второго преподавателя, либо 0 - нет преподавателя, -1 - по умолчанию из группы.

Example:

123

date

string

Дата начала занятия.

Example:

2025-10-23

start_time

string

Время начала занятия.

Example:

16:00

event_comment

string

Комментарий к занятию.

Example:

Комментарий

description

string

Описание.

Example:

Описание

video

string

Видеообложка.

Example:

https://vkvideo.ru/video-123_123

display_online

boolean

Отображать в онлайн-сервисах.

Example:

true

disable_listing

boolean

Запретить онлайн запись на занятие.

Example:

false

stream_copy_group_settings

boolean

Онлайн трансляция и запись занятия. Скопировать настройки группы.

Example:

false

stream_type

string

Онлайн трансляция и запись занятия. Тип. no - оффлайн занятие, record - запись занятия, stream - онлайн трансляция.

Example:

stream_url

string

Онлайн трансляция и запись занятия. Ссылка на онлайн трансляцию или запись занятия.

Example:

https://vkvideo.ru/video-123_123

admission_coef

number

Онлайн трансляция и запись занятия. Списывать N занятий за доступ к трансляции / видео.

Example:

stream_access_before

integer

Онлайн трансляция и запись занятия. Трансляция / Запись доступна до занятия (мин).

Example:

stream_access_after

integer

Онлайн трансляция и запись занятия. Трансляция / Запись доступна после занятия (мин).

Example:

Response Fields

event_id

ID занятия

description

Описание занятия

type

string

Тип занятия

week_day

День недели

date

string

Дата занятия

end_date_time

Дата и время окончания

start_time

Время начала

end_time

Время окончания

created_at

string

Дата и время создания

updated_at

string

Дата и время последнего обновления

deleted_at

integer

Дата удаления (если удалено)

display_online

Отображение занятия в онлайн сервисах

places_left

Количество свободных мест на занятии. Есть только при загрузке 1 занятия

group_id

ID группы

event_comment

Комментарий к занятию

teacher_name

Имя основного преподавателя

second_teacher_name

Имя второго преподавателя

room_name

Название зала

group_name

Название группы

max_attendance_limit

Максимальное количество людей на занятии. 0 - неограниченно

group_type_name

Название направления

office_name

Название филиала

Example request:

curl --request POST \
    "https://yourdomain.listokcrm.ru/api/external/v2/events" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"office_id\": 123,
    \"group_id\": 123,
    \"room_id\": 123,
    \"contact_id\": 123,
    \"contact_id2\": 123,
    \"date\": \"2025-10-23\",
    \"start_time\": \"16:00\",
    \"event_comment\": \"Комментарий\",
    \"description\": \"Описание\",
    \"video\": \"https:\\/\\/vkvideo.ru\\/video-123_123\",
    \"display_online\": true,
    \"disable_listing\": false,
    \"stream_copy_group_settings\": false,
    \"stream_type\": \"no\",
    \"stream_url\": \"https:\\/\\/vkvideo.ru\\/video-123_123\",
    \"admission_coef\": 1,
    \"stream_access_before\": 1,
    \"stream_access_after\": 1
}"

Example response:

{
    "event_id": 9,
    "description": null,
    "type": "copy",
    "week_day": 0,
    "date": "2023-10-09",
    "end_date_time": null,
    "start_time": "07:00",
    "end_time": "08:00",
    "admission_coef": 1,
    "created_at": "2023-10-09T07:13:40.000000Z",
    "updated_at": "2023-10-09T07:13:40.000000Z",
    "deleted_at": 0,
    "display_online": 1,
    "group_id": 1,
    "event_comment": "",
    "teacher_name": null,
    "second_teacher_name": null,
    "room_name": "Тренажерный Зал 1",
    "group_name": "Тестовая группа",
    "max_attendance_limit": 3,
    "group_type_name": "Нпрвлне",
    "office_name": "Основной 1"
}

Получить данные занятия

GET

https://yourdomain.listokcrm.ru

/api/external/v2/events/{eventId}

requires authentication

Метод предоставляет данные о конкретном неудаленном занятии по ID. Также метод предоставляет данные о записанных, в том числе в Лист ожидания, и отмеченных клиентах

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

eventId

integer

required

ID занятия

Example:

Response Fields

event_id

ID занятия

description

Описание занятия

type

string

Тип занятия

week_day

День недели

date

string

Дата занятия

end_date_time

Дата и время окончания

start_time

Время начала

end_time

Время окончания

created_at

string

Дата и время создания

updated_at

string

Дата и время последнего обновления

deleted_at

integer

Дата удаления (если удалено)

display_online

Отображение занятия в онлайн сервисах

places_left

Количество свободных мест на занятии. Есть только при загрузке 1 занятия

group_id

ID группы

event_comment

Комментарий к занятию

teacher_name

Имя основного преподавателя

second_teacher_name

Имя второго преподавателя

room_name

Название зала

group_name

Название группы

max_attendance_limit

Максимальное количество людей на занятии. 0 - неограниченно

group_type_name

Название направления

office_name

Название филиала

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/events/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "event_id": 9,
    "description": null,
    "type": "copy",
    "week_day": 0,
    "date": "2023-10-09",
    "end_date_time": null,
    "start_time": "07:00",
    "end_time": "08:00",
    "admission_coef": 1,
    "created_at": "2023-10-09T07:13:40.000000Z",
    "updated_at": "2023-10-09T07:13:40.000000Z",
    "deleted_at": 0,
    "display_online": 1,
    "group_id": 1,
    "event_comment": "",
    "teacher_name": null,
    "second_teacher_name": null,
    "room_name": "Тренажерный Зал 1",
    "group_name": "Тестовая группа",
    "max_attendance_limit": 3,
    "group_type_name": "Нпрвлне",
    "office_name": "Основной 1"
}

Редактировать занятие

PUT

PATCH

https://yourdomain.listokcrm.ru

/api/external/v2/events/{eventId}

requires authentication

Метод позволяет редактировать занятие

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

eventId

integer

required

ID занятия

Example:

Body Parameters

office_id

integer

Филиал.

Example:

123

group_id

integer

Группа.

Example:

123

room_id

integer

Зал.

Example:

123

contact_id

integer

ID преподавателя, либо 0 - нет преподавателя, -1 - по умолчанию из группы.

Example:

123

contact_id2

integer

ID второго преподавателя, либо 0 - нет преподавателя, -1 - по умолчанию из группы.

Example:

123

date

string

Дата начала занятия.

Example:

2025-10-23

start_time

string

Время начала занятия.

Example:

16:00

event_comment

string

Комментарий к занятию.

Example:

Комментарий

description

string

Описание.

Example:

Описание

video

string

Видеообложка.

Example:

https://vkvideo.ru/video-123_123

display_online

boolean

Отображать в онлайн-сервисах.

Example:

true

disable_listing

boolean

Запретить онлайн запись на занятие.

Example:

false

stream_copy_group_settings

boolean

Онлайн трансляция и запись занятия. Скопировать настройки группы.

Example:

false

stream_type

string

Онлайн трансляция и запись занятия. Тип. no - оффлайн занятие, record - запись занятия, stream - онлайн трансляция.

Example:

stream_url

string

Онлайн трансляция и запись занятия. Ссылка на онлайн трансляцию или запись занятия.

Example:

https://vkvideo.ru/video-123_123

admission_coef

number

Онлайн трансляция и запись занятия. Списывать N занятий за доступ к трансляции / видео.

Example:

stream_access_before

integer

Онлайн трансляция и запись занятия. Трансляция / Запись доступна до занятия (мин).

Example:

stream_access_after

integer

Онлайн трансляция и запись занятия. Трансляция / Запись доступна после занятия (мин).

Example:

Response Fields

event_id

ID занятия

description

Описание занятия

type

string

Тип занятия

week_day

День недели

date

string

Дата занятия

end_date_time

Дата и время окончания

start_time

Время начала

end_time

Время окончания

created_at

string

Дата и время создания

updated_at

string

Дата и время последнего обновления

deleted_at

integer

Дата удаления (если удалено)

display_online

Отображение занятия в онлайн сервисах

places_left

Количество свободных мест на занятии. Есть только при загрузке 1 занятия

group_id

ID группы

event_comment

Комментарий к занятию

teacher_name

Имя основного преподавателя

second_teacher_name

Имя второго преподавателя

room_name

Название зала

group_name

Название группы

max_attendance_limit

Максимальное количество людей на занятии. 0 - неограниченно

group_type_name

Название направления

office_name

Название филиала

Example request:

curl --request PUT \
    "https://yourdomain.listokcrm.ru/api/external/v2/events/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"office_id\": 123,
    \"group_id\": 123,
    \"room_id\": 123,
    \"contact_id\": 123,
    \"contact_id2\": 123,
    \"date\": \"2025-10-23\",
    \"start_time\": \"16:00\",
    \"event_comment\": \"Комментарий\",
    \"description\": \"Описание\",
    \"video\": \"https:\\/\\/vkvideo.ru\\/video-123_123\",
    \"display_online\": true,
    \"disable_listing\": false,
    \"stream_copy_group_settings\": false,
    \"stream_type\": \"no\",
    \"stream_url\": \"https:\\/\\/vkvideo.ru\\/video-123_123\",
    \"admission_coef\": 1,
    \"stream_access_before\": 1,
    \"stream_access_after\": 1
}"

Example response:

{
    "event_id": 9,
    "description": null,
    "type": "copy",
    "week_day": 0,
    "date": "2023-10-09",
    "end_date_time": null,
    "start_time": "07:00",
    "end_time": "08:00",
    "admission_coef": 1,
    "created_at": "2023-10-09T07:13:40.000000Z",
    "updated_at": "2023-10-09T07:13:40.000000Z",
    "deleted_at": 0,
    "display_online": 1,
    "group_id": 1,
    "event_comment": "",
    "teacher_name": null,
    "second_teacher_name": null,
    "room_name": "Тренажерный Зал 1",
    "group_name": "Тестовая группа",
    "max_attendance_limit": 3,
    "group_type_name": "Нпрвлне",
    "office_name": "Основной 1"
}

Удалить занятие

DELETE

https://yourdomain.listokcrm.ru

/api/external/v2/events/{eventId}

requires authentication

Метод позволяет удалить занятие по ID

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

eventId

integer

required

ID занятия

Example:

Example request:

curl --request DELETE \
    "https://yourdomain.listokcrm.ru/api/external/v2/events/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Заявки

Создать заявку

POST

https://yourdomain.listokcrm.ru

/api/external/v2/inquiry

requires authentication

Метод создает заявки от конкретного клиента

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Body Parameters

cform_id

integer

Id формы захвата.

Example:

12345

contact_id

integer

Id клиента.

Example:

12345

note

string

Заметка.

Example:

Новый клиент

source

string

Источник: vk, mobile, website, call, cform.

Example:

call

Example request:

curl --request POST \
    "https://yourdomain.listokcrm.ru/api/external/v2/inquiry" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"cform_id\": 12345,
    \"contact_id\": 12345,
    \"note\": \"Новый клиент\",
    \"source\": \"call\"
}"

Источники

Получить список источников

GET

https://yourdomain.listokcrm.ru

/api/external/v2/sources

requires authentication

Метод предоставляет список источников

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Query Parameters

page

integer

required

Страница

Example:

Response Fields

source_id

required

ID источника

name

string

required

Название источника

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/sources?page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "source_id": -6,
            "name": "Telegram"
        },
        {
            "source_id": -6,
            "name": "Telegram"
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Клиент

Получить список клиентов

GET

https://yourdomain.listokcrm.ru

/api/external/v2/contacts

requires authentication

Метод предоставляет данные о всех неудаленных клиентах

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Query Parameters

page

integer

required

Страница

Example:

name

string

ФИО.

Example:

Иванов Иван Иванович

phone

string

Телефон.

Example:

+79529991122, в любом формате

string

Email.

Example:

test@test.ru

Response Fields

contact_id

required

ID клиента

name

string

required

ФИО клиента

name_short

string

Обращение

gender

string

Пол

birth_date

Дата рождения

string

Email клиента (доступен при наличии разрешения)

phone_alt

string

Альтернативный номер телефона

phone

string

Основной номер телефона (доступен при наличии разрешения)

note

string

Заметка о клиенте

sticky_note

Закрепленная заметка о клиенте

photo

string

Ссылка на фото клиента

barcode

string

Штрихкод

created_at

string

Дата создания клиента

updated_at

string

Дата последнего изменения клиента

deleted_at

integer

Дата удаления клиента (если клиент удален)

balance

integer

Баланс клиента

bonus_balance

Баланс бонусов клиента

parent_name

ФИО родителя

parent_phone

Телефон родителя (доступен при наличии разрешения)

parent_email

Email родителя

parent_name2

ФИО второго родителя

parent_phone2

Телефон второго родителя (доступен при наличии разрешения)

parent_email2

Email второго родителя

search_score

Рейтинг совпадения при поиске

added_office_id

Филиал клиента

customer_status

Статус клиента

vkid

string

ID ВКонтакте

fbid

string

ID Facebook

instaid

string

ID Instagram

has_trial_passes

Наличие пробных абонементов

has_non_trial_passes

Наличие НЕ пробных абонементов

last_admission_date

ID занятия, где было последнее посещение

last_pass_purchased

ID последнего оформленного абонемента

first_non_trial

Дата покупки первого НЕ пробного абонемента

last_non_trial

Дата покупки последнего НЕ пробного абонемента

source_id

Источник

can_email

Разрешено ли отправлять Email

can_sms

Разрешено ли отправлять SMS

can_wa

Разрешено ли отправлять сообщения в WhatsApp

can_tg

Разрешено ли отправлять сообщения в Telegram

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/contacts?page=1&name=%D0%98%D0%B2%D0%B0%D0%BD%D0%BE%D0%B2+%D0%98%D0%B2%D0%B0%D0%BD+%D0%98%D0%B2%D0%B0%D0%BD%D0%BE%D0%B2%D0%B8%D1%87&phone=%2B79529991122%2C+%D0%B2+%D0%BB%D1%8E%D0%B1%D0%BE%D0%BC+%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%82%D0%B5&email=test%40test.ru" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "contact_id": 1,
            "name": "Иванов Иван Иваныч",
            "name_short": "",
            "gender": "male",
            "birth_date": "1990-01-02",
            "email": "ivanov2@mail.co",
            "phone_alt": "",
            "phone": "9991111111",
            "note": "",
            "sticky_note": "",
            "photo": "",
            "barcode": "0000000000001",
            "created_at": "2016-03-17T05:48:50.000000Z",
            "updated_at": "2025-02-06T07:14:58.000000Z",
            "deleted_at": 0,
            "balance": 0,
            "bonus_balance": 0,
            "parent_name": "",
            "parent_phone": "0",
            "parent_email": "",
            "parent_name2": "",
            "parent_phone2": "",
            "parent_email2": "0",
            "search_score": null,
            "added_office_id": 0,
            "customer_status": "client",
            "vkid": "",
            "fbid": "",
            "instaid": "",
            "has_trial_passes": 0,
            "has_non_trial_passes": 0,
            "last_admission_date": 0,
            "last_pass_purchased": 0,
            "first_non_trial": 0,
            "last_non_trial": 0,
            "source_id": 0,
            "can_email": 0,
            "can_sms": 0,
            "can_wa": 0,
            "can_tg": 0
        },
        {
            "contact_id": 1,
            "name": "Иванов Иван Иваныч",
            "name_short": "",
            "gender": "male",
            "birth_date": "1990-01-02",
            "email": "ivanov2@mail.co",
            "phone_alt": "",
            "phone": "9991111111",
            "note": "",
            "sticky_note": "",
            "photo": "",
            "barcode": "0000000000001",
            "created_at": "2016-03-17T05:48:50.000000Z",
            "updated_at": "2025-02-06T07:14:58.000000Z",
            "deleted_at": 0,
            "balance": 0,
            "bonus_balance": 0,
            "parent_name": "",
            "parent_phone": "0",
            "parent_email": "",
            "parent_name2": "",
            "parent_phone2": "",
            "parent_email2": "0",
            "search_score": null,
            "added_office_id": 0,
            "customer_status": "client",
            "vkid": "",
            "fbid": "",
            "instaid": "",
            "has_trial_passes": 0,
            "has_non_trial_passes": 0,
            "last_admission_date": 0,
            "last_pass_purchased": 0,
            "first_non_trial": 0,
            "last_non_trial": 0,
            "source_id": 0,
            "can_email": 0,
            "can_sms": 0,
            "can_wa": 0,
            "can_tg": 0
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Создать клиента

POST

https://yourdomain.listokcrm.ru

/api/external/v2/contacts

requires authentication

Метод создает нового клиента

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Body Parameters

name

string

Имя клиента.

Example:

Иванов Иван Иванович

phone

string

Телефон клиента.

Example:

79239239293

string

Email клиента.

Example:

user@example.com

gender

string

Пол клиента: female, male.

Example:

male

can_sms

boolean

Разрешение на отправку SMS.

Example:

true

can_email

boolean

Разрешение на отправку email.

Example:

true

added_office_id

integer

Филиал добавивший клиента.

Example:

source_id

string

Id источника.

Example:

Response Fields

contact_id

required

ID клиента

name

string

required

ФИО клиента

name_short

string

Обращение

gender

string

Пол

birth_date

Дата рождения

string

Email клиента (доступен при наличии разрешения)

phone_alt

string

Альтернативный номер телефона

phone

string

Основной номер телефона (доступен при наличии разрешения)

note

string

Заметка о клиенте

sticky_note

Закрепленная заметка о клиенте

photo

string

Ссылка на фото клиента

barcode

string

Штрихкод

created_at

string

Дата создания клиента

updated_at

string

Дата последнего изменения клиента

deleted_at

integer

Дата удаления клиента (если клиент удален)

balance

integer

Баланс клиента

bonus_balance

Баланс бонусов клиента

parent_name

ФИО родителя

parent_phone

Телефон родителя (доступен при наличии разрешения)

parent_email

Email родителя

parent_name2

ФИО второго родителя

parent_phone2

Телефон второго родителя (доступен при наличии разрешения)

parent_email2

Email второго родителя

search_score

Рейтинг совпадения при поиске

added_office_id

Филиал клиента

customer_status

Статус клиента

vkid

string

ID ВКонтакте

fbid

string

ID Facebook

instaid

string

ID Instagram

has_trial_passes

Наличие пробных абонементов

has_non_trial_passes

Наличие НЕ пробных абонементов

last_admission_date

ID занятия, где было последнее посещение

last_pass_purchased

ID последнего оформленного абонемента

first_non_trial

Дата покупки первого НЕ пробного абонемента

last_non_trial

Дата покупки последнего НЕ пробного абонемента

source_id

Источник

can_email

Разрешено ли отправлять Email

can_sms

Разрешено ли отправлять SMS

can_wa

Разрешено ли отправлять сообщения в WhatsApp

can_tg

Разрешено ли отправлять сообщения в Telegram

Example request:

curl --request POST \
    "https://yourdomain.listokcrm.ru/api/external/v2/contacts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"name\": \"Иванов Иван Иванович\",
    \"phone\": \"79239239293\",
    \"email\": \"user@example.com\",
    \"gender\": \"male\",
    \"can_sms\": true,
    \"can_email\": true,
    \"added_office_id\": 1,
    \"source_id\": 1
}"

Example response:

{
    "contact_id": 1,
    "name": "Иванов Иван Иваныч",
    "name_short": "",
    "gender": "male",
    "birth_date": "1990-01-02",
    "email": "ivanov2@mail.co",
    "phone_alt": "",
    "phone": "9991111111",
    "note": "",
    "sticky_note": "",
    "photo": "",
    "barcode": "0000000000001",
    "created_at": "2016-03-17T05:48:50.000000Z",
    "updated_at": "2025-02-06T07:14:58.000000Z",
    "deleted_at": 0,
    "balance": 0,
    "bonus_balance": 0,
    "parent_name": "",
    "parent_phone": "0",
    "parent_email": "",
    "parent_name2": "",
    "parent_phone2": "",
    "parent_email2": "0",
    "search_score": null,
    "added_office_id": 0,
    "customer_status": "client",
    "vkid": "",
    "fbid": "",
    "instaid": "",
    "has_trial_passes": 0,
    "has_non_trial_passes": 0,
    "last_admission_date": 0,
    "last_pass_purchased": 0,
    "first_non_trial": 0,
    "last_non_trial": 0,
    "source_id": 0,
    "can_email": 0,
    "can_sms": 0,
    "can_wa": 0,
    "can_tg": 0
}

Получить данные клиента

GET

https://yourdomain.listokcrm.ru

/api/external/v2/contacts/{contactId}

requires authentication

Метод предоставляет данные о конкретном клиенте по ID

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

contactId

integer

required

ID клиента

Example:

Response Fields

contact_id

required

ID клиента

name

string

required

ФИО клиента

name_short

string

Обращение

gender

string

Пол

birth_date

Дата рождения

string

Email клиента (доступен при наличии разрешения)

phone_alt

string

Альтернативный номер телефона

phone

string

Основной номер телефона (доступен при наличии разрешения)

note

string

Заметка о клиенте

sticky_note

Закрепленная заметка о клиенте

photo

string

Ссылка на фото клиента

barcode

string

Штрихкод

created_at

string

Дата создания клиента

updated_at

string

Дата последнего изменения клиента

deleted_at

integer

Дата удаления клиента (если клиент удален)

balance

integer

Баланс клиента

bonus_balance

Баланс бонусов клиента

parent_name

ФИО родителя

parent_phone

Телефон родителя (доступен при наличии разрешения)

parent_email

Email родителя

parent_name2

ФИО второго родителя

parent_phone2

Телефон второго родителя (доступен при наличии разрешения)

parent_email2

Email второго родителя

search_score

Рейтинг совпадения при поиске

added_office_id

Филиал клиента

customer_status

Статус клиента

vkid

string

ID ВКонтакте

fbid

string

ID Facebook

instaid

string

ID Instagram

has_trial_passes

Наличие пробных абонементов

has_non_trial_passes

Наличие НЕ пробных абонементов

last_admission_date

ID занятия, где было последнее посещение

last_pass_purchased

ID последнего оформленного абонемента

first_non_trial

Дата покупки первого НЕ пробного абонемента

last_non_trial

Дата покупки последнего НЕ пробного абонемента

source_id

Источник

can_email

Разрешено ли отправлять Email

can_sms

Разрешено ли отправлять SMS

can_wa

Разрешено ли отправлять сообщения в WhatsApp

can_tg

Разрешено ли отправлять сообщения в Telegram

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/contacts/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "contact_id": 1,
    "name": "Иванов Иван Иваныч",
    "name_short": "",
    "gender": "male",
    "birth_date": "1990-01-02",
    "email": "ivanov2@mail.co",
    "phone_alt": "",
    "phone": "9991111111",
    "note": "",
    "sticky_note": "",
    "photo": "",
    "barcode": "0000000000001",
    "created_at": "2016-03-17T05:48:50.000000Z",
    "updated_at": "2025-02-06T07:14:58.000000Z",
    "deleted_at": 0,
    "balance": 0,
    "bonus_balance": 0,
    "parent_name": "",
    "parent_phone": "0",
    "parent_email": "",
    "parent_name2": "",
    "parent_phone2": "",
    "parent_email2": "0",
    "search_score": null,
    "added_office_id": 0,
    "customer_status": "client",
    "vkid": "",
    "fbid": "",
    "instaid": "",
    "has_trial_passes": 0,
    "has_non_trial_passes": 0,
    "last_admission_date": 0,
    "last_pass_purchased": 0,
    "first_non_trial": 0,
    "last_non_trial": 0,
    "source_id": 0,
    "can_email": 0,
    "can_sms": 0,
    "can_wa": 0,
    "can_tg": 0
}

Абонементы

Оформить абонемент клиенту

POST

https://yourdomain.listokcrm.ru

/api/external/v2/contacts/{contact_contactId}/passes/{pass_passId}

requires authentication

Метод позволяет оформить абонемент клиенту

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

contact_contactId

integer

required

ID клиента

Example:

pass_passId

integer

required

ID абонемента

Example:

Body Parameters

amount

number

Сумма.

Example:

1000

cashregister_id

string

Способ внесения средств.

Example:

Response Fields

pass_contact_id

ID абонемента клиента

pass_id

ID вида абонемента

is_trial

Является ли пробным абонементом

sold_at

integer

Дата продажи абонемента

created_at

string

Дата создания записи

updated_at

string

Дата последнего обновления

deleted_at

Дата удаления записи (если применимо)

debt_dead_line_at

Срок погашения задолженности

expires_at

string

Дата истечения абонемента

expired_at

string

Фактическая дата истечения абонемента

activated_at

string

Дата активации абонемента

frozen_till_at

string

Дата окончания заморозки

planned_freeze_at

Дата запланированной заморозки

paid_price

Оплаченная сумма за абонемент

full_price

Полная стоимость абонемента

discounted

integer

Размер скидки

status

string

Статус абонемента

class_type

Тип абонемента

points_left

Оставшееся количество посещений

points_total

Общее количество посещений

freeze_times

Количество использованных заморозок

comment

string

Комментарий к абонементу

revoke_comment

Комментарий к аннулированию абонемента

Example request:

curl --request POST \
    "https://yourdomain.listokcrm.ru/api/external/v2/contacts/1/passes/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"amount\": 1000,
    \"cashregister_id\": 1
}"

Example response:

{
    "pass_contact_id": 1,
    "pass_id": 1,
    "is_trial": 0,
    "sold_at": 1696852602,
    "created_at": "2023-10-09T11:56:42.000000Z",
    "updated_at": "2024-08-22T04:40:02.000000Z",
    "deleted_at": null,
    "debt_dead_line_at": null,
    "expires_at": "2023-12-16T09:00:00.000000Z",
    "expired_at": "0000-00-00",
    "activated_at": "2023-10-09T09:00:00.000000Z",
    "frozen_till_at": "2024-07-16T09:00:00.000000Z",
    "planned_freeze_at": null,
    "paid_price": 2000,
    "full_price": 2000,
    "discounted": 0,
    "status": "frozen",
    "class_type": "ege",
    "points_left": 11,
    "points_total": 10,
    "freeze_times": 100,
    "comment": "",
    "revoke_comment": "",
    "pass": {
        "pass_id": 1,
        "name": "Абонемент на 10 занятий",
        "description": "",
        "admit_number": 12,
        "valid_for_days": 31,
        "valid_for_months": 0,
        "freeze_times": 100,
        "freeze_days": 100,
        "pass_type": 1,
        "price": 2000,
        "allowed_times": [],
        "disabled_days": [],
        "allow_buying_pass_mobile": 0,
        "allow_buying_pass_online": 0
    }
}

Получить список абонементов клиента

GET

https://yourdomain.listokcrm.ru

/api/external/v2/contacts/{contact_contactId}/passes

requires authentication

Метод предоставляет данные о всех абонементах клиента. Абонементы фильтруются по статусу: активный, неактивированный, замороженный, истекший, отозванный

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

contact_contactId

integer

required

ID клиента

Example:

Query Parameters

status

string

required

Статус: active, expired, frozen, inactive, revoked

Example:

active

page

integer

required

Страница

Example:

Response Fields

pass_contact_id

ID абонемента клиента

pass_id

ID вида абонемента

is_trial

Является ли пробным абонементом

sold_at

integer

Дата продажи абонемента

created_at

string

Дата создания записи

updated_at

string

Дата последнего обновления

deleted_at

Дата удаления записи (если применимо)

debt_dead_line_at

Срок погашения задолженности

expires_at

string

Дата истечения абонемента

expired_at

string

Фактическая дата истечения абонемента

activated_at

string

Дата активации абонемента

frozen_till_at

string

Дата окончания заморозки

planned_freeze_at

Дата запланированной заморозки

paid_price

Оплаченная сумма за абонемент

full_price

Полная стоимость абонемента

discounted

integer

Размер скидки

status

string

Статус абонемента

class_type

Тип абонемента

points_left

Оставшееся количество посещений

points_total

Общее количество посещений

freeze_times

Количество использованных заморозок

comment

string

Комментарий к абонементу

revoke_comment

Комментарий к аннулированию абонемента

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/contacts/1/passes?status=active&page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "pass_contact_id": 1,
            "pass_id": 1,
            "is_trial": 0,
            "sold_at": 1696852602,
            "created_at": "2023-10-09T11:56:42.000000Z",
            "updated_at": "2024-08-22T04:40:02.000000Z",
            "deleted_at": null,
            "debt_dead_line_at": null,
            "expires_at": "2023-12-16T09:00:00.000000Z",
            "expired_at": "0000-00-00",
            "activated_at": "2023-10-09T09:00:00.000000Z",
            "frozen_till_at": "2024-07-16T09:00:00.000000Z",
            "planned_freeze_at": null,
            "paid_price": 2000,
            "full_price": 2000,
            "discounted": 0,
            "status": "frozen",
            "class_type": "ege",
            "points_left": 11,
            "points_total": 10,
            "freeze_times": 100,
            "comment": "",
            "revoke_comment": "",
            "pass": {
                "pass_id": 1,
                "name": "Абонемент на 10 занятий",
                "description": "",
                "admit_number": 12,
                "valid_for_days": 31,
                "valid_for_months": 0,
                "freeze_times": 100,
                "freeze_days": 100,
                "pass_type": 1,
                "price": 2000,
                "allowed_times": [],
                "disabled_days": [],
                "allow_buying_pass_mobile": 0,
                "allow_buying_pass_online": 0
            }
        },
        {
            "pass_contact_id": 1,
            "pass_id": 1,
            "is_trial": 0,
            "sold_at": 1696852602,
            "created_at": "2023-10-09T11:56:42.000000Z",
            "updated_at": "2024-08-22T04:40:02.000000Z",
            "deleted_at": null,
            "debt_dead_line_at": null,
            "expires_at": "2023-12-16T09:00:00.000000Z",
            "expired_at": "0000-00-00",
            "activated_at": "2023-10-09T09:00:00.000000Z",
            "frozen_till_at": "2024-07-16T09:00:00.000000Z",
            "planned_freeze_at": null,
            "paid_price": 2000,
            "full_price": 2000,
            "discounted": 0,
            "status": "frozen",
            "class_type": "ege",
            "points_left": 11,
            "points_total": 10,
            "freeze_times": 100,
            "comment": "",
            "revoke_comment": "",
            "pass": {
                "pass_id": 1,
                "name": "Абонемент на 10 занятий",
                "description": "",
                "admit_number": 12,
                "valid_for_days": 31,
                "valid_for_months": 0,
                "freeze_times": 100,
                "freeze_days": 100,
                "pass_type": 1,
                "price": 2000,
                "allowed_times": [],
                "disabled_days": [],
                "allow_buying_pass_mobile": 0,
                "allow_buying_pass_online": 0
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Получить данные абонемента

GET

https://yourdomain.listokcrm.ru

/api/external/v2/contacts/{contact_contactId}/passes/{passContact_pass_contactId}

requires authentication

Метод предоставляет данные о конкретном абонементе конкретного клиента

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

contact_contactId

integer

required

ID клиента

Example:

passContact_pass_contactId

integer

required

ID абонемента клиента

Example:

Response Fields

pass_contact_id

ID абонемента клиента

pass_id

ID вида абонемента

is_trial

Является ли пробным абонементом

sold_at

integer

Дата продажи абонемента

created_at

string

Дата создания записи

updated_at

string

Дата последнего обновления

deleted_at

Дата удаления записи (если применимо)

debt_dead_line_at

Срок погашения задолженности

expires_at

string

Дата истечения абонемента

expired_at

string

Фактическая дата истечения абонемента

activated_at

string

Дата активации абонемента

frozen_till_at

string

Дата окончания заморозки

planned_freeze_at

Дата запланированной заморозки

paid_price

Оплаченная сумма за абонемент

full_price

Полная стоимость абонемента

discounted

integer

Размер скидки

status

string

Статус абонемента

class_type

Тип абонемента

points_left

Оставшееся количество посещений

points_total

Общее количество посещений

freeze_times

Количество использованных заморозок

comment

string

Комментарий к абонементу

revoke_comment

Комментарий к аннулированию абонемента

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/contacts/1/passes/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "pass_contact_id": 1,
    "pass_id": 1,
    "is_trial": 0,
    "sold_at": 1696852602,
    "created_at": "2023-10-09T11:56:42.000000Z",
    "updated_at": "2024-08-22T04:40:02.000000Z",
    "deleted_at": null,
    "debt_dead_line_at": null,
    "expires_at": "2023-12-16T09:00:00.000000Z",
    "expired_at": "0000-00-00",
    "activated_at": "2023-10-09T09:00:00.000000Z",
    "frozen_till_at": "2024-07-16T09:00:00.000000Z",
    "planned_freeze_at": null,
    "paid_price": 2000,
    "full_price": 2000,
    "discounted": 0,
    "status": "frozen",
    "class_type": "ege",
    "points_left": 11,
    "points_total": 10,
    "freeze_times": 100,
    "comment": "",
    "revoke_comment": "",
    "pass": {
        "pass_id": 1,
        "name": "Абонемент на 10 занятий",
        "description": "",
        "admit_number": 12,
        "valid_for_days": 31,
        "valid_for_months": 0,
        "freeze_times": 100,
        "freeze_days": 100,
        "pass_type": 1,
        "price": 2000,
        "allowed_times": [],
        "disabled_days": [],
        "allow_buying_pass_mobile": 0,
        "allow_buying_pass_online": 0
    }
}

Записи

Получить список записей клиента

GET

https://yourdomain.listokcrm.ru

/api/external/v2/contacts/{contact_contactId}/listings

requires authentication

Метод предоставляет данные о всех записях на занятия конкретного клиента. Дополнительно метод производит поиск по id занятия, чтобы проверить запись клиента на конкретное занятие

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

contact_contactId

integer

required

ID клиента

Example:

Query Parameters

page

integer

required

Страница

Example:

event_id

string

Id занаятия.

Example:

12345

missed

string

Пропуск.

Example:

true

Response Fields

listing_id

required

ID записи

event_id

required

ID занятия

contact_id

required

ID клиента

source

string

Источник записи

missed_pass_contact_id

ID абонемента, по которому было списание за посещение

is_missed

Поставлен ли записи пропуск

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/contacts/1/listings?page=1&event_id=12345&missed=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "listing_id": 55,
            "event_id": 163308,
            "contact_id": 15,
            "source": "",
            "missed_pass_contact_id": 0,
            "is_missed": false
        },
        {
            "listing_id": 55,
            "event_id": 163308,
            "contact_id": 15,
            "source": "",
            "missed_pass_contact_id": 0,
            "is_missed": false
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Отменить запись клиента на занятие

DELETE

https://yourdomain.listokcrm.ru

/api/external/v2/contacts/{contact_contactId}/listings/{listingContact_listingId}

requires authentication

Метод позволяет отменить одну запись конкретного клиента с конкретного занятия

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

contact_contactId

integer

required

ID клиента

Example:

listingContact_listingId

integer

required

ID записи

Example:

Example request:

curl --request DELETE \
    "https://yourdomain.listokcrm.ru/api/external/v2/contacts/1/listings/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Записать клиента на занятие

POST

https://yourdomain.listokcrm.ru

/api/external/v2/contacts/{contact_contactId}/listings

requires authentication

Метод позволяет записать конкретного клиента на конкретное занятие. Не позволит записать клиента в лист ожидания. Для этого используется отдельные метод: «Добавить в лист ожидания»

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

contact_contactId

integer

required

ID клиента

Example:

Body Parameters

event_id

string

Id занаятия.

Example:

12345

Response Fields

listing_id

required

ID записи

event_id

required

ID занятия

contact_id

required

ID клиента

source

string

Источник записи

missed_pass_contact_id

ID абонемента, по которому было списание за посещение

is_missed

Поставлен ли записи пропуск

Example request:

curl --request POST \
    "https://yourdomain.listokcrm.ru/api/external/v2/contacts/1/listings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"event_id\": \"12345\"
}"

Example response:

{
    "listing_id": 55,
    "event_id": 163308,
    "contact_id": 15,
    "source": "",
    "missed_pass_contact_id": 0,
    "is_missed": false
}

Посещения

Получить список посещений клиента

GET

https://yourdomain.listokcrm.ru

/api/external/v2/contacts/{contact_contactId}/admissions

requires authentication

Метод предоставляет список всех посещений конкретного клиента. По дополнительному параметру eventId,метод предоставит данные о посещении на конкретном занятии

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

contact_contactId

integer

required

ID клиента

Example:

Query Parameters

page

integer

required

Страница

Example:

event_id

string

Id занаятия.

Example:

12345

Response Fields

admission_id

required

ID посещения

event_id

required

ID занятия

contact_id

required

ID клиента

is_debt

Было ли посещение в долг

pass_contact_id

ID абонемента, по которому прошло посещение

created_at

required

Дата и время отмечания на занятии

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/contacts/1/admissions?page=1&event_id=12345" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "admission_id": 2,
            "event_id": 18,
            "contact_id": 4,
            "is_debt": false,
            "pass_contact_id": 2,
            "created_at": "2023-10-31T04:21:53.000000Z"
        },
        {
            "admission_id": 2,
            "event_id": 18,
            "contact_id": 4,
            "is_debt": false,
            "pass_contact_id": 2,
            "created_at": "2023-10-31T04:21:53.000000Z"
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Отменить посещение клиента

DELETE

https://yourdomain.listokcrm.ru

/api/external/v2/contacts/{contact_contactId}/admissions/{admissionContact_admissionId}

requires authentication

Метод позволяет отменить посещение конкретного клиента

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

contact_contactId

integer

required

ID клиента

Example:

admissionContact_admissionId

integer

required

ID посещения

Example:

Example request:

curl --request DELETE \
    "https://yourdomain.listokcrm.ru/api/external/v2/contacts/1/admissions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Отметить посещение клиента

POST

https://yourdomain.listokcrm.ru

/api/external/v2/contacts/{contact_contactId}/admissions

requires authentication

Метод позволит отметить конкретного клиента на конкретном занятии

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

contact_contactId

integer

required

ID клиента

Example:

Body Parameters

event_id

string

Id занаятия.

Example:

12345

pass_contact_id

string

Id абонемента клиента, если не указать и у клиента нет абонемента - посещение в долг.

Example:

12345

Response Fields

admission_id

required

ID посещения

event_id

required

ID занятия

contact_id

required

ID клиента

is_debt

Было ли посещение в долг

pass_contact_id

ID абонемента, по которому прошло посещение

created_at

required

Дата и время отмечания на занятии

Example request:

curl --request POST \
    "https://yourdomain.listokcrm.ru/api/external/v2/contacts/1/admissions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"event_id\": \"12345\",
    \"pass_contact_id\": \"12345\"
}"

Example response:

{
    "admission_id": 2,
    "event_id": 18,
    "contact_id": 4,
    "is_debt": false,
    "pass_contact_id": 2,
    "created_at": "2023-10-31T04:21:53.000000Z"
}

Лист ожидания

Получить список записей клиента из листа ожидания

GET

https://yourdomain.listokcrm.ru

/api/external/v2/contacts/{contact_contactId}/queue

requires authentication

Метод предоставляет все записи из листа ожидания конкретного клиента. Условие: на аккаунте включен лист ожидания

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

contact_contactId

integer

required

ID клиента

Example:

Query Parameters

page

integer

required

Страница

Example:

Response Fields

queue_id

required

ID записи в листе ожидания

event_id

required

ID занятия

contact_id

required

ID клиента

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/contacts/1/queue?page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "queue_id": 5,
            "event_id": 23,
            "contact_id": 4
        },
        {
            "queue_id": 5,
            "event_id": 23,
            "contact_id": 4
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Отменить запись клиента в листе ожидания

DELETE

https://yourdomain.listokcrm.ru

/api/external/v2/contacts/{contact_contactId}/queue/{queueContact_queueId}

requires authentication

Метод позволяет отменить запись клиента в листе ожидания. Условие: на аккаунте включен лист ожидания

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

contact_contactId

integer

required

ID клиента

Example:

queueContact_queueId

integer

required

ID листа ожидания

Example:

Response Fields

queue_id

required

ID записи в листе ожидания

event_id

required

ID занятия

contact_id

required

ID клиента

Example request:

curl --request DELETE \
    "https://yourdomain.listokcrm.ru/api/external/v2/contacts/1/queue/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "queue_id": 5,
    "event_id": 23,
    "contact_id": 4
}

Добавить клиента в лист ожидания

POST

https://yourdomain.listokcrm.ru

/api/external/v2/contacts/{contact_contactId}/queue

requires authentication

Метод позволяет добавить конкретного клиента в лист ожидания на занятие. Условие: на аккаунте включен лист ожидания

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

contact_contactId

integer

required

ID клиента

Example:

Body Parameters

event_id

string

Id занятия.

Example:

12345

Response Fields

queue_id

required

ID записи в листе ожидания

event_id

required

ID занятия

contact_id

required

ID клиента

Example request:

curl --request POST \
    "https://yourdomain.listokcrm.ru/api/external/v2/contacts/1/queue" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"event_id\": \"12345\"
}"

Example response:

{
    "queue_id": 5,
    "event_id": 23,
    "contact_id": 4
}

Платежи

Получить список платежей клиента

GET

https://yourdomain.listokcrm.ru

/api/external/v2/contacts/{contact_contactId}/payments

requires authentication

Метод предоставляет все неудаленные платежи по конкретному клиенту

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

contact_contactId

integer

required

ID клиента

Example:

Query Parameters

page

integer

required

Страница

Example:

Response Fields

payment_id

required

ID платежа

from_id

required

ID отправителя платежа

to_id

required

ID получателя платежа

user_id

ID пользователя, который провел платеж

direction

string

required

Направление платежа (доход/расход)

reason

string

Основание

date

string

Дата платежа

amount

integer

required

Сумма платежа

full_price

Полная стоимость заказа или абонемента

balance_paid

Оплачено с баланса

total_discount_amount

Общая сумма скидки

discount_bonus_amount

Сумма скидки, оплаченная бонусами

discount_amount

Сумма скидки (за вычетом бонусов)

payment_type

required

Тип платежа (абонемент, сертификат, заказ, баланс)

init_price

Изначальная стоимость абонемента или заказа

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/contacts/1/payments?page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "payment_id": 1,
            "from_id": 4,
            "to_id": -1,
            "user_id": 1,
            "direction": "income",
            "reason": "Покупка абонемента &quot;Абонемент на 10 занятий&quot; #1. ",
            "date": "09.10.2023",
            "amount": 2000,
            "full_price": 2000,
            "balance_paid": 0,
            "total_discount_amount": 0,
            "discount_bonus_amount": null,
            "discount_amount": 0,
            "payment_type": "pass",
            "init_price": 0,
            "discounts": {
                "discounts": [
                    {
                        "name": "Another one",
                        "original_name": "Another one",
                        "type": "regular",
                        "amount": 0,
                        "amount_fixed": 0,
                        "amount_percent": 15,
                        "amount_type": null,
                        "code_word": "",
                        "contact_id": 0,
                        "country_id": 1,
                        "discount_id": 3,
                        "discounts_left": 0,
                        "discountslot_id": null,
                        "dynamic_calculator": null,
                        "dynamic_type": null,
                        "limit_per_contact": null,
                        "limited": 0,
                        "master_id": 0,
                        "use_for": "any",
                        "used": 0,
                        "valid_til": null,
                        "pivot": {
                            "amount": 2000,
                            "amountPaid": 2000,
                            "contactId": null,
                            "discountAlgorithm": "sum",
                            "discountAmount": 0,
                            "discountId": 3,
                            "discount_amountFixed": 0,
                            "discount_amountPercent": 15,
                            "discount_codeWord": null,
                            "discount_name": "Another one",
                            "discount_useFor": "any",
                            "order": null,
                            "paymentId": 1
                        }
                    }
                ]
            }
        },
        {
            "payment_id": 1,
            "from_id": 4,
            "to_id": -1,
            "user_id": 1,
            "direction": "income",
            "reason": "Покупка абонемента &quot;Абонемент на 10 занятий&quot; #1. ",
            "date": "09.10.2023",
            "amount": 2000,
            "full_price": 2000,
            "balance_paid": 0,
            "total_discount_amount": 0,
            "discount_bonus_amount": null,
            "discount_amount": 0,
            "payment_type": "pass",
            "init_price": 0,
            "discounts": {
                "discounts": [
                    {
                        "name": "Another one",
                        "original_name": "Another one",
                        "type": "regular",
                        "amount": 0,
                        "amount_fixed": 0,
                        "amount_percent": 15,
                        "amount_type": null,
                        "code_word": "",
                        "contact_id": 0,
                        "country_id": 1,
                        "discount_id": 3,
                        "discounts_left": 0,
                        "discountslot_id": null,
                        "dynamic_calculator": null,
                        "dynamic_type": null,
                        "limit_per_contact": null,
                        "limited": 0,
                        "master_id": 0,
                        "use_for": "any",
                        "used": 0,
                        "valid_til": null,
                        "pivot": {
                            "amount": 2000,
                            "amountPaid": 2000,
                            "contactId": null,
                            "discountAlgorithm": "sum",
                            "discountAmount": 0,
                            "discountId": 3,
                            "discount_amountFixed": 0,
                            "discount_amountPercent": 15,
                            "discount_codeWord": null,
                            "discount_name": "Another one",
                            "discount_useFor": "any",
                            "order": null,
                            "paymentId": 1
                        }
                    }
                ]
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Направления

Получить список направлений

GET

https://yourdomain.listokcrm.ru

/api/external/v2/grouptypes

requires authentication

Метод предоставляет данные о всех неудаленных направлениях

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Query Parameters

page

integer

required

Страница

Example:

Response Fields

group_type_id

required

ID направления

name

string

required

Название направления

description

string

Описание для онлайн расписания

hide_on_vk

Отображать в онлайн-сервисах (null - да, hideOnVk - нет)

color

string

required

Цвет направления

video

string

Видео обложка (с YouTube или VK Видео) для онлайн расписания (ссылка)

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/grouptypes?page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "group_type_id": 2,
            "name": "Второе направление",
            "description": "",
            "hide_on_vk": "",
            "color": "#3f4bd4",
            "video": ""
        },
        {
            "group_type_id": 2,
            "name": "Второе направление",
            "description": "",
            "hide_on_vk": "",
            "color": "#3f4bd4",
            "video": ""
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Создать направление

POST

https://yourdomain.listokcrm.ru

/api/external/v2/grouptypes

requires authentication

Метод позволяет создать направление

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Body Parameters

name

string

Название направления.

Example:

Фитнес

color

string

Цвет в hex.

Example:

#ffffff

description

string

Описание для онлайн расписания.

Example:

Фитнес

hide_on_vk

string

Отображать в онлайн-сервисах (null - да, hideOnVk - нет).

video

string

Видео обложка (с YouTube или VK Видео) для онлайн расписания (ссылка).

Example:

https://vkvideo.ru/video-123_123

Response Fields

group_type_id

required

ID направления

name

string

required

Название направления

description

string

Описание для онлайн расписания

hide_on_vk

Отображать в онлайн-сервисах (null - да, hideOnVk - нет)

color

string

required

Цвет направления

video

string

Видео обложка (с YouTube или VK Видео) для онлайн расписания (ссылка)

Example request:

curl --request POST \
    "https://yourdomain.listokcrm.ru/api/external/v2/grouptypes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"name\": \"Фитнес\",
    \"color\": \"#ffffff\",
    \"description\": \"Фитнес\",
    \"hide_on_vk\": \"\",
    \"video\": \"https:\\/\\/vkvideo.ru\\/video-123_123\"
}"

Example response:

{
    "group_type_id": 2,
    "name": "Второе направление",
    "description": "",
    "hide_on_vk": "",
    "color": "#3f4bd4",
    "video": ""
}

Получить данные направления

GET

https://yourdomain.listokcrm.ru

/api/external/v2/grouptypes/{groupTypeId}

requires authentication

Метод предоставляет данные о конкретном направлении по ID

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

groupTypeId

integer

required

ID направления

Example:

Response Fields

group_type_id

required

ID направления

name

string

required

Название направления

description

string

Описание для онлайн расписания

hide_on_vk

Отображать в онлайн-сервисах (null - да, hideOnVk - нет)

color

string

required

Цвет направления

video

string

Видео обложка (с YouTube или VK Видео) для онлайн расписания (ссылка)

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/grouptypes/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "group_type_id": 2,
    "name": "Второе направление",
    "description": "",
    "hide_on_vk": "",
    "color": "#3f4bd4",
    "video": ""
}

Редактировать направление

PUT

PATCH

https://yourdomain.listokcrm.ru

/api/external/v2/grouptypes/{groupTypeId}

requires authentication

Метод позволяет редактировать направление

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

groupTypeId

integer

required

Example:

Body Parameters

name

string

Название направления.

Example:

Фитнес

color

string

Цвет в hex.

Example:

#ffffff

description

string

Описание для онлайн расписания.

Example:

Фитнес

hide_on_vk

string

Отображать в онлайн-сервисах (null - да, hideOnVk - нет).

video

string

Видео обложка (с YouTube или VK Видео) для онлайн расписания (ссылка).

Example:

https://vkvideo.ru/video-123_123

Response Fields

group_type_id

required

ID направления

name

string

required

Название направления

description

string

Описание для онлайн расписания

hide_on_vk

Отображать в онлайн-сервисах (null - да, hideOnVk - нет)

color

string

required

Цвет направления

video

string

Видео обложка (с YouTube или VK Видео) для онлайн расписания (ссылка)

Example request:

curl --request PUT \
    "https://yourdomain.listokcrm.ru/api/external/v2/grouptypes/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"name\": \"Фитнес\",
    \"color\": \"#ffffff\",
    \"description\": \"Фитнес\",
    \"hide_on_vk\": \"\",
    \"video\": \"https:\\/\\/vkvideo.ru\\/video-123_123\"
}"

Example response:

{
    "group_type_id": 2,
    "name": "Второе направление",
    "description": "",
    "hide_on_vk": "",
    "color": "#3f4bd4",
    "video": ""
}

Удалить направление

DELETE

https://yourdomain.listokcrm.ru

/api/external/v2/grouptypes/{groupTypeId}

requires authentication

Метод позволяет удалить направление по ID

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

groupTypeId

integer

required

ID направления

Example:

Example request:

curl --request DELETE \
    "https://yourdomain.listokcrm.ru/api/external/v2/grouptypes/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Платежи

Получить список способов оплаты

GET

https://yourdomain.listokcrm.ru

/api/external/v2/cash-register

requires authentication

Метод предоставляет список всех созданных типов способов оплаты

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Query Parameters

page

integer

required

Страница

Example:

Response Fields

cashregister_id

required

ID способа оплаты

type

string

required

Тип способа оплаты (наличный/безналичный)

name

string

required

Название способа оплаты

is_system

required

Является ли способ оплаты системным

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/cash-register?page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "cashregister_id": 1,
            "type": "cash",
            "name": "Наличный",
            "is_system": 1
        },
        {
            "cashregister_id": 1,
            "type": "cash",
            "name": "Наличный",
            "is_system": 1
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Сотрудники

Преподаватели

Получить список преподавателей

GET

https://yourdomain.listokcrm.ru

/api/external/v2/employees/teachers

requires authentication

Метод предоставляет список всех не удаленных преподавателей

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Query Parameters

page

integer

required

Страница

Example:

name

string

ФИО.

Example:

Иванов Иван Иванович

phone

string

Телефон.

Example:

+79529991122, в любом формате

string

Email.

Example:

test@test.ru

Response Fields

contact_id

required

ID клиента

name

string

required

ФИО клиента

name_short

string

Обращение

gender

string

Пол

birth_date

Дата рождения

string

Email клиента (доступен при наличии разрешения)

phone_alt

string

Альтернативный номер телефона

phone

string

Основной номер телефона (доступен при наличии разрешения)

note

string

Заметка о клиенте

sticky_note

Закрепленная заметка о клиенте

photo

string

Ссылка на фото клиента

barcode

string

Штрихкод

created_at

string

Дата создания клиента

updated_at

string

Дата последнего изменения клиента

deleted_at

integer

Дата удаления клиента (если клиент удален)

balance

integer

Баланс клиента

bonus_balance

Баланс бонусов клиента

parent_name

ФИО родителя

parent_phone

Телефон родителя (доступен при наличии разрешения)

parent_email

Email родителя

parent_name2

ФИО второго родителя

parent_phone2

Телефон второго родителя (доступен при наличии разрешения)

parent_email2

Email второго родителя

search_score

Рейтинг совпадения при поиске

added_office_id

Филиал клиента

customer_status

Статус клиента

vkid

string

ID ВКонтакте

fbid

string

ID Facebook

instaid

string

ID Instagram

has_trial_passes

Наличие пробных абонементов

has_non_trial_passes

Наличие НЕ пробных абонементов

last_admission_date

ID занятия, где было последнее посещение

last_pass_purchased

ID последнего оформленного абонемента

first_non_trial

Дата покупки первого НЕ пробного абонемента

last_non_trial

Дата покупки последнего НЕ пробного абонемента

source_id

Источник

can_email

Разрешено ли отправлять Email

can_sms

Разрешено ли отправлять SMS

can_wa

Разрешено ли отправлять сообщения в WhatsApp

can_tg

Разрешено ли отправлять сообщения в Telegram

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/employees/teachers?page=1&name=%D0%98%D0%B2%D0%B0%D0%BD%D0%BE%D0%B2+%D0%98%D0%B2%D0%B0%D0%BD+%D0%98%D0%B2%D0%B0%D0%BD%D0%BE%D0%B2%D0%B8%D1%87&phone=%2B79529991122%2C+%D0%B2+%D0%BB%D1%8E%D0%B1%D0%BE%D0%BC+%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%82%D0%B5&email=test%40test.ru" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "contact_id": 1,
            "name": "Иванов Иван Иваныч",
            "name_short": "",
            "gender": "male",
            "birth_date": "1990-01-02",
            "email": "ivanov2@mail.co",
            "phone_alt": "",
            "phone": "9991111111",
            "note": "",
            "sticky_note": "",
            "photo": "",
            "barcode": "0000000000001",
            "created_at": "2016-03-17T05:48:50.000000Z",
            "updated_at": "2025-02-06T07:14:58.000000Z",
            "deleted_at": 0,
            "balance": 0,
            "bonus_balance": 0,
            "parent_name": "",
            "parent_phone": "0",
            "parent_email": "",
            "parent_name2": "",
            "parent_phone2": "",
            "parent_email2": "0",
            "search_score": null,
            "added_office_id": 0,
            "customer_status": "client",
            "vkid": "",
            "fbid": "",
            "instaid": "",
            "has_trial_passes": 0,
            "has_non_trial_passes": 0,
            "last_admission_date": 0,
            "last_pass_purchased": 0,
            "first_non_trial": 0,
            "last_non_trial": 0,
            "source_id": 0,
            "can_email": 0,
            "can_sms": 0,
            "can_wa": 0,
            "can_tg": 0
        },
        {
            "contact_id": 1,
            "name": "Иванов Иван Иваныч",
            "name_short": "",
            "gender": "male",
            "birth_date": "1990-01-02",
            "email": "ivanov2@mail.co",
            "phone_alt": "",
            "phone": "9991111111",
            "note": "",
            "sticky_note": "",
            "photo": "",
            "barcode": "0000000000001",
            "created_at": "2016-03-17T05:48:50.000000Z",
            "updated_at": "2025-02-06T07:14:58.000000Z",
            "deleted_at": 0,
            "balance": 0,
            "bonus_balance": 0,
            "parent_name": "",
            "parent_phone": "0",
            "parent_email": "",
            "parent_name2": "",
            "parent_phone2": "",
            "parent_email2": "0",
            "search_score": null,
            "added_office_id": 0,
            "customer_status": "client",
            "vkid": "",
            "fbid": "",
            "instaid": "",
            "has_trial_passes": 0,
            "has_non_trial_passes": 0,
            "last_admission_date": 0,
            "last_pass_purchased": 0,
            "first_non_trial": 0,
            "last_non_trial": 0,
            "source_id": 0,
            "can_email": 0,
            "can_sms": 0,
            "can_wa": 0,
            "can_tg": 0
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Филиалы

Получить список филиалов

GET

https://yourdomain.listokcrm.ru

/api/external/v2/offices

requires authentication

Метод предоставляет данные о всех неудаленных филиалах

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Query Parameters

page

integer

required

Страница

Example:

Response Fields

office_id

required

ID филиала

name

string

required

Название филиала

address

string

Адрес филиала

hide_online

Скрывать в онлайн-сервисах

is_main

Основной филиал

order

integer

Порядок отображения

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/offices?page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "office_id": 0,
            "name": "Основной 1",
            "is_main": 1,
            "address": "Адрес 123, 14",
            "hide_online": 0,
            "order": 0
        },
        {
            "office_id": 0,
            "name": "Основной 1",
            "is_main": 1,
            "address": "Адрес 123, 14",
            "hide_online": 0,
            "order": 0
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Создать филиал

POST

https://yourdomain.listokcrm.ru

/api/external/v2/offices

requires authentication

Метод позволяет создать филиал

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Body Parameters

name

string

Название филиала.

Example:

Филиал на Новой

hide_online

string

Не показывать в онлайн-сервисах.

Example:

address

string

Адрес.

Example:

ул. Новая 123

order

integer

Порядок отображения.

Example:

123

Response Fields

office_id

required

ID филиала

name

string

required

Название филиала

address

string

Адрес филиала

hide_online

Скрывать в онлайн-сервисах

is_main

Основной филиал

order

integer

Порядок отображения

Example request:

curl --request POST \
    "https://yourdomain.listokcrm.ru/api/external/v2/offices" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"name\": \"Филиал на Новой\",
    \"hide_online\": 0,
    \"address\": \"ул. Новая 123\",
    \"order\": 123
}"

Example response:

{
    "office_id": 0,
    "name": "Основной 1",
    "is_main": 1,
    "address": "Адрес 123, 14",
    "hide_online": 0,
    "order": 0
}

Получить данные филиала

GET

https://yourdomain.listokcrm.ru

/api/external/v2/offices/{officeId}

requires authentication

Метод предоставляет данные о конкретном филиале по ID

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

officeId

integer

required

ID филиала

Example:

Response Fields

office_id

required

ID филиала

name

string

required

Название филиала

address

string

Адрес филиала

hide_online

Скрывать в онлайн-сервисах

is_main

Основной филиал

order

integer

Порядок отображения

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/offices/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "office_id": 0,
    "name": "Основной 1",
    "is_main": 1,
    "address": "Адрес 123, 14",
    "hide_online": 0,
    "order": 0
}

Редактировать филиал

PUT

PATCH

https://yourdomain.listokcrm.ru

/api/external/v2/offices/{officeId}

requires authentication

Метод позволяет редактировать филиал

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

officeId

integer

required

ID филиала

Example:

Body Parameters

name

string

Название филиала.

Example:

Филиал на Новой

hide_online

string

Не показывать в онлайн-сервисах.

Example:

address

string

Адрес.

Example:

ул. Новая 123

order

integer

Порядок отображения.

Example:

123

Response Fields

office_id

required

ID филиала

name

string

required

Название филиала

address

string

Адрес филиала

hide_online

Скрывать в онлайн-сервисах

is_main

Основной филиал

order

integer

Порядок отображения

Example request:

curl --request PUT \
    "https://yourdomain.listokcrm.ru/api/external/v2/offices/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest" \
    --data "{
    \"name\": \"Филиал на Новой\",
    \"hide_online\": 0,
    \"address\": \"ул. Новая 123\",
    \"order\": 123
}"

Example response:

{
    "office_id": 0,
    "name": "Основной 1",
    "is_main": 1,
    "address": "Адрес 123, 14",
    "hide_online": 0,
    "order": 0
}

Удалить филиал

DELETE

https://yourdomain.listokcrm.ru

/api/external/v2/offices/{officeId}

requires authentication

Метод позволяет удалить филиал по ID

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

URL Parameters

officeId

integer

required

ID филиала

Example:

Example request:

curl --request DELETE \
    "https://yourdomain.listokcrm.ru/api/external/v2/offices/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Формы захвата

Получить список форм захвата

GET

https://yourdomain.listokcrm.ru

/api/external/v2/inquiry-forms

requires authentication

Метод предоставляет список всех созданных форм захвата

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

X-Requested-With

Example:

XMLHttpRequest

Query Parameters

page

integer

required

Страница

Example:

Response Fields

cform_id

required

ID формы

name

string

required

Название формы

Example request:

curl --request GET \
    --get "https://yourdomain.listokcrm.ru/api/external/v2/inquiry-forms?page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-Requested-With: XMLHttpRequest"

Example response:

{
    "data": [
        {
            "cform_id": 1,
            "name": "еуые"
        },
        {
            "cform_id": 1,
            "name": "еуые"
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}