Документация

API

Формат запросов, ответов и справочник полей для интеграций.

ФорматОрганизацииПерсоналРесурсыГруппы услугУслугиКлиентыСобытияЗаписиКастомные поляФинансы

Персонал

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

URL персонала

Для персонала используется общий API данных с именем раздела staff.

МетодURLОписание
GET/api/?mod=data&data=staffПолучить список сотрудников текущей организации.
GET/api/?mod=data&data=staff&id=IDПолучить одну карточку сотрудника по id.
POST/api/?mod=save_data&data=staffСоздать новую карточку сотрудника или сохранить существующую. Для обновления передайте id в теле запроса.
POST/api/?mod=delete_data&data=staff&id=IDУдалить карточку сотрудника по id.
ПолеТипОбязательноеDefaultЗначенияСохранениеСписокКарточкаОписание
namestringДаНетЛюбоеИмя сотрудника, которое видят пользователи кабинета и клиенты.
groupsarrayДаНетЛюбоеГруппы или направления услуг. Передаются массивом строк. Пример: ["Парикмахер", "Колорист"].
idnumberНетНетЛюбоеИдентификатор существующей карточки сотрудника. При создании не передается.
sort_ordernumberНетautoЛюбоеПозиция сотрудника в сортировке списка. Заполняется сервером.
positionstringНетНетЛюбоеДолжность или специализация сотрудника.
descriptionstringНетНетЛюбоеОписание для публичных сценариев и виджета.
commentstringНетНетЛюбоеВнутренний комментарий по сотруднику.
photoimageНетНетЛюбоеПодготовленная фотография сотрудника.
photo_originalimageНетНетЛюбоеИсходное изображение для фотографии сотрудника.
photo_settingsjsonНетНетЛюбоеНастройки кадрирования фотографии.
roleselectНетparticipantparticipantadminРоль сотрудника в кабинете.
notify_mebooleanНетНетfalsetrueЛичная подписка текущего пользователя на уведомления по этой карточке персонала.
access_chatbooleanНетfalsefalsetrueДоступ к чату и входящим заявкам клиентов.
access_eventsbooleanНетfalsefalsetrueДоступ к событиям организации.
statusselectНетactiveactivepausedarchivedСтатус карточки сотрудника.
customFieldsobjectНетНетЛюбоеЗначения кастомных полей по uid. Для сохранения используйте поле custom_fields в теле запроса.
userobjectНетНетЛюбоеСвязанный пользователь, если приглашение уже принято.
inviteobjectНетНетЛюбоеСвязанное приглашение сотрудника.

Ответы с ошибками

Если запрос не выполнен, API возвращает ok=false и числовой code. Подробности по полям передаются в errors[].type.

КодКогда возникаетОтвет
16Не переданы обязательные name или groups, либо обязательные кастомные поля персонала.required со списком незаполненных полей.
17Поля персонала переданы, но не прошли проверку типа, списка значений или изображения.errors со списком ошибок полей.
11-14Нет доступа к сотруднику, созданию, сохранению, удалению или превышен лимит тарифа.message с причиной отказа.
Тип ошибкиПолеКогда возникает
select_errorrole, statusЗначение не входит в разрешенный список.
image_errorphoto, photo_originalИзображение передано в неподдерживаемом формате или не прошло обработку.