Skip to main content

Заголовки запроса

string
required
API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат: Bearer YOUR_TOKEN.
string
required
Уникальный идентификатор продавца в системе. Используется для разграничения доступа между разными продавцами.
string
required
Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.
Отсутствие (absence) фиксирует период, когда сотрудник не работает: отсутствие без уточнения причины (Absent), отпуск (Vacation), отгул (DayOff), командировку (BusinessTrip), больничный (SickLeave), отпуск по уходу за ребёнком (ParentalLeave) или учебный отпуск (StudyLeave). Отсутствие привязывается к трудоустройству сотрудника.
Создание, обновление и удаление отсутствия автоматически синхронизирует статус пользователя ActiveOnLeave: если у пользователя есть текущее (действующее на данный момент) отсутствие — статус становится OnLeave, если текущих отсутствий не осталось — возвращается Active. OnLeave — информационный статус: вход и доступ к платформе он не блокирует. Переходы не затрагивают пользователей в других статусах (Banned, Blocked, Terminated). Помимо пересчёта при API-вызовах, платформа раз в час автоматически сверяет статусы с календарём: отсутствие с будущей датой начала переведёт сотрудника в OnLeave при её наступлении, а истёкшее — вернёт Active без каких-либо вызовов с вашей стороны.
Все эндпоинты модуля staff доступны только для школ сегмента Corporate. Для остальных сегментов запрос вернёт ошибку 403 Forbidden.

Список отсутствий

Требуется аутентификация и право StaffView.

Параметры запроса

Параметры-массивы передаются повторением параметра в строке запроса: employmentIds=1&employmentIds=2.

Пагинация

integer
Количество записей, которые нужно пропустить. По умолчанию 0.
integer
Номер страницы (альтернатива skip). Начинается с 1.
integer
Количество записей на странице. По умолчанию 100, максимум 1000.

Фильтрация

string[]
Фильтр по внешним идентификаторам (extId) отсутствий. До 250 значений, каждое до 50 символов.
integer[]
Фильтр по ID трудоустройств. До 250 значений.
integer[]
Фильтр по ID должностей. До 250 значений.
enum[]
Фильтр по типам отсутствия. Возможные значения: Absent, Vacation, DayOff, BusinessTrip, SickLeave, ParentalLeave, StudyLeave. До 250 значений.
boolean
Если true — вернуть только текущие (активные на данный момент) отсутствия.

Поля ответа

object
Постраничный список отсутствий.

Создать отсутствие

Требуется аутентификация и право StaffManage.

Параметры запроса

Трудоустройство указывается ровно одним из двух полей: employmentId или employmentExtId.
string
Внешний идентификатор отсутствия из системы клиента. От 1 до 50 символов, без / и пробелов. Должен быть уникален в рамках школы среди неудалённых записей — иначе вернётся ошибка StaffAbsenceExtIdIsNotUniq.
integer
ID трудоустройства сотрудника, к которому относится отсутствие. Обязателен, если не передан employmentExtId.
string
Внешний идентификатор (extId) трудоустройства. Альтернатива employmentId — обязателен, если не передан employmentId. Если трудоустройство не найдено в школе — вернётся ошибка StaffEmploymentNotFound.
enum
required
Тип отсутствия. Возможные значения: Absent (отсутствует), Vacation (отпуск), DayOff (отгул), BusinessTrip (командировка), SickLeave (больничный), ParentalLeave (отпуск по уходу за ребёнком), StudyLeave (учебный отпуск).
string
required
Дата начала отсутствия в формате ISO 8601. Должна быть не позже finishAt.
string
Дата окончания отсутствия в формате ISO 8601. Должна быть не раньше startAt.
string
Комментарий к отсутствию. Максимум 500 символов. Автоматически обрезаются пробелы в начале и конце.

Обновить отсутствие

Требуется аутентификация и право StaffManage. Обновляет поля отсутствия. Все поля тела необязательны — передавайте только те, которые нужно изменить. Привязку к трудоустройству (employmentId) изменить нельзя.

Параметры запроса

integer
required
ID обновляемого отсутствия.
string
Внешний идентификатор отсутствия из системы клиента. От 1 до 50 символов, без / и пробелов. Должен быть уникален в рамках школы среди неудалённых записей — иначе вернётся ошибка StaffAbsenceExtIdIsNotUniq.
enum
Тип отсутствия. Возможные значения: Absent, Vacation, DayOff, BusinessTrip, SickLeave, ParentalLeave, StudyLeave.
string
Дата начала отсутствия в формате ISO 8601. Должна быть не позже finishAt.
string
Дата окончания отсутствия в формате ISO 8601. Должна быть не раньше startAt.
string
Комментарий к отсутствию. Максимум 500 символов.

Обновить отсутствие по extId

Требуется аутентификация и право StaffManage. Аналог обновления по absenceId, но отсутствие идентифицируется внешним идентификатором (extId) в рамках школы. Тело запроса такое же, как у PUT /saas/v2/staff/absence/{absenceId}/update.

Параметры запроса

string
required
Внешний идентификатор обновляемого отсутствия. Передаётся в URL-encoded виде.
string
Новый внешний идентификатор отсутствия. От 1 до 50 символов, без / и пробелов. Должен быть уникален в рамках школы среди неудалённых записей.
enum
Тип отсутствия. Возможные значения: Absent, Vacation, DayOff, BusinessTrip, SickLeave, ParentalLeave, StudyLeave.
string
Дата начала отсутствия в формате ISO 8601. Должна быть не позже finishAt.
string
Дата окончания отсутствия в формате ISO 8601. Должна быть не раньше startAt.
string
Комментарий к отсутствию. Максимум 500 символов.

Удалить отсутствие

Требуется аутентификация и право StaffManage.

Параметры запроса

integer
required
ID удаляемого отсутствия.

Ответ

integer
required
Количество удалённых записей (1 при успешном удалении).

Удалить отсутствие по extId

Требуется аутентификация и право StaffManage. Аналог удаления по absenceId, но отсутствие идентифицируется внешним идентификатором (extId) в рамках школы.

Параметры запроса

string
required
Внешний идентификатор удаляемого отсутствия. Передаётся в URL-encoded виде.

Ответ

integer
required
Количество удалённых записей (1 при успешном удалении).

Требования к правам доступа

Модуль staff доступен только для школ сегмента Corporate. Для чтения списка требуется право StaffView, для создания, обновления и удаления отсутствий — право StaffManage.
Сервисный пользователь должен быть аутентифицирован по токену и иметь соответствующие права доступа к указанной школе.

Обновлено: 2026-07-14 22:58 UTC