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

Практические материалы по запуску и развитию

Здесь собраны инструкции по запуску, разработке внутренних сценариев и встраиванию собственных инструментов в рабочий контур компании.

folderИнтеграции и API

Open API

Полный список внешних методов Open API Synchra.24 по разделам: время, задачи, заявки, сотрудники, отчеты и другие сервисы.

Open API нужен в тех случаях, когда Synchra.24 должна не только работать как приложение для сотрудников, но и обмениваться данными с внешними системами компании.

Чаще всего интеграции используют в трех сценариях:

забирать данные из активности во внешнюю систему;
создавать записи в Synchra.24 из внешней системы;
синхронизировать справочники, задачи, заявки, документы и другие процессы между несколькими сервисами.

Этот документ построен в двух частях:

сначала показаны основные сценарии с понятными примерами;
ниже идет полный каталог методов по разделам в одном и том же формате.

Как устроен доступ

Для Open API чаще всего нужны два заголовка:

X-OpenAPI-Token — токен интеграции;
X-Provider-Token — токен конкретной активности.

Если говорить проще:

X-OpenAPI-Token подтверждает, что интеграция вообще имеет право работать;
X-Provider-Token подтверждает, с какой именно активностью вы сейчас работаете.

Базовая цепочка работы

Обычно интеграция выглядит так:

вы создаете Open API токен в параметрах активности;
вызываете метод параметров активности и получаете provider token;
дальше вызываете методы нужного раздела уже с двумя заголовками.

Первый обязательный запрос:

GET /api/v1/providers/user/params/{provider_id}
X-OpenAPI-Token: <ваш_openapi_token>

Из ответа нужно взять:

result.token — это и есть X-Provider-Token;
при необходимости остальные параметры активности.

Дальше большинство запросов будут выглядеть так:

X-OpenAPI-Token: <ваш_openapi_token>
X-Provider-Token: <token_активности>
Content-Type: application/json

Что важно помнить

Лимит Open API: 100 запросов в минуту на один X-OpenAPI-Token.
Многие GET-методы поддерживают общие query-поля: page, size, search, sort, date_from, date_to.
Там, где backend уже задает устойчивую структуру body, ниже приведены конкретные поля и примеры.
Там, где метод принимает более свободный JSON, это отдельно отмечено.

Основные сценарии

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

Метод: GET /api/v1/providers/user/params/{provider_id}
Что делает: возвращает параметры активности, включая result.token.
Path: provider_id
Query: нет
Body: не нужен

Создать отдел

Метод: POST /api/v1/providers/division/create
Что делает: создает новый отдел внутри активности.
Path: нет
Query: нет
Body: JSON

{
  "name": "Склад",
  "description": "Основной склад и приемка"
}

Обновить отдел

Метод: PATCH /api/v1/providers/division/{division_id}
Что делает: обновляет название и описание отдела.
Path: division_id
Query: нет
Body: JSON

{
  "name": "Склад и логистика",
  "description": "Приемка, хранение и отгрузка"
}

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

Метод: POST /api/v1/providers/position/create
Что делает: создает ставку внутри отдела.
Path: нет
Query: нет
Body: JSON

{
  "name": "Кладовщик",
  "division_id": 12,
  "salary_amount": 85000,
  "work_mode": [1, 2, 3, 4, 5],
  "work_time": 8,
  "work_start": "09:00",
  "work_end": "18:00"
}

Обновить ставку

Метод: PATCH /api/v1/providers/position/{position_id}
Что делает: обновляет параметры ставки.
Path: position_id
Query: нет
Body: JSON

{
  "name": "Старший кладовщик",
  "salary_amount": 95000,
  "work_mode": [1, 2, 3, 4, 5],
  "work_time": 8,
  "work_start": "09:00",
  "work_end": "18:00"
}

Создать роль

Метод: POST /api/v1/providers/roles/add
Что делает: создает роль и сразу назначает ей набор прав.
Path: нет
Query: нет
Body: JSON

{
  "name": "Руководитель склада",
  "description": "Управляет складом и видит сотрудников отдела",
  "parent_id": 3,
  "permissions": [
    "tasks",
    "requests",
    "reports",
    "control",
    "contacts"
  ]
}

Обновить роль

Метод: PATCH /api/v1/providers/roles/update/{role_id}
Что делает: обновляет роль и список прав.
Path: role_id
Query: нет
Body: JSON

{
  "name": "Старший смены",
  "description": "Контроль смены и задач",
  "parent_id": 3,
  "permissions": [
    "tasks",
    "incidents",
    "reports"
  ]
}

Создать свое право доступа

Метод: POST /api/v1/providers/roles/custom-permissions
Что делает: добавляет собственное право доступа, которое потом можно назначать ролям.
Path: нет
Query: нет
Body: JSON

{
  "name": "Просмотр внутреннего сервиса логистики",
  "value": "logistics_service_view"
}

Создать задачу

Метод: POST /api/v1/tasks/create
Что делает: создает новую задачу.
Path: нет
Query: нет
Body: JSON

{
  "title": "Проверить поставку №104",
  "description": "Сверить документы и принять товар на складе",
  "created_by": "25",
  "assigned_to": [25, 31],
  "priority_id": 2,
  "status_id": 1,
  "deadline": "2026-05-30T18:00:00Z",
  "related_task_ids": [],
  "task_checklist": [],
  "files": [],
  "photos": [],
  "voice": {"file":"","bars":"","ms":0}
}

Обновить задачу

Метод: PATCH /api/v1/tasks/update/{task_id}
Что делает: обновляет карточку задачи.
Path: task_id
Query: нет
Body: JSON

{
  "title": "Проверить поставку №104 и закрыть расхождения",
  "description": "Сверить документы, товар и закрыть приемку",
  "assigned_to": [25],
  "priority_id": 3,
  "deadline": "2026-05-31T18:00:00Z",
  "updated_by": "25",
  "related_task_ids": [101, 102],
  "task_checklist": [],
  "files": [],
  "photos": [],
  "voice": {"file":"","bars":"","ms":0}
}

Изменить статус задачи

Метод: PATCH /api/v1/tasks/status/{task_id}
Что делает: переводит задачу в новый статус.
Path: task_id
Query: нет
Body: JSON

{
  "status_alias": "in_progress",
  "comment": "Задача взята в работу",
  "changed_by": 25
}

Обновить чек-лист задачи

Метод: PATCH /api/v1/tasks/checklist/{task_id}
Что делает: отмечает или снимает конкретный пункт чек-листа.
Path: task_id
Query: нет
Body: JSON

{
  "section_id": "receiving",
  "item_id": "check-documents",
  "checked": true
}

Создать отчет

Метод: POST /api/v1/reports/create
Что делает: создает отчет сотрудника.
Path: нет
Query: нет
Body: JSON

{
  "session_id": 1045,
  "date": 1779400800,
  "description": "Проверили поставку, приняли товар, закрыли расхождения",
  "files": [],
  "photos": [],
  "voice": {"file":"","bars":"","ms":0}
}

Создать шаблон заявки

Метод: POST /api/v1/requests/template/create
Что делает: создает шаблон заявки с блоками и маршрутом согласования.
Path: нет
Query: нет
Body: JSON

{
  "title": "Заявка на закупку",
  "description": "Согласование закупки материалов",
  "blocks": [
    {
      "id": "reason",
      "title": "Что нужно купить",
      "description": "Кратко опишите закупку",
      "type": "textarea",
      "sort_index": 1,
      "options": []
    }
  ],
  "approvers": [
    {
      "user_id": 41,
      "division_ids": [12]
    }
  ]
}

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

Метод: POST /api/v1/requests/create
Что делает: создает заявку по шаблону.
Path: нет
Query: нет
Body: JSON

{
  "template_id": 7,
  "answers": [
    {
      "block_id": "reason",
      "text": "Нужно закупить коробки и маркировку",
      "options": []
    }
  ]
}

Создать шаблон инцидента

Метод: POST /api/v1/incidents/template/create
Что делает: создает шаблон для типового инцидента.
Path: нет
Query: нет
Body: JSON

{
  "title": "Повреждение товара",
  "assigned_to": [31, 44],
  "priority": 2,
  "provider_email": "ops@company.ru",
  "description_template": "Опишите место, причину и приложите фото"
}

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

Метод: POST /api/v1/incidents/create
Что делает: создает инцидент и отправляет его назначенным сотрудникам.
Path: нет
Query: нет
Body: JSON

{
  "title": "Повреждение паллеты",
  "description": "При приемке обнаружено повреждение упаковки",
  "assigned_to": [31],
  "priority": 2,
  "template": 4,
  "session_id": 1045,
  "files": [],
  "photos": [],
  "voice": {"file":"","bars":"","ms":0}
}

Создать событие календаря

Метод: POST /api/v1/calendar/create
Что делает: создает событие в календаре активности.
Path: нет
Query: нет
Body: JSON

{
  "title": "Планерка смены",
  "description": "Короткая встреча перед началом рабочего дня",
  "location": "Склад, зона приемки",
  "user_ids": [25, 31, 44],
  "starts_at": "2026-05-30T08:45:00Z",
  "ends_at": "2026-05-30T09:00:00Z",
  "add_to_device_calendar": true,
  "files": [],
  "photos": [],
  "voice": {"file":"","bars":"","ms":0}
}

Создать отпускной план

Метод: POST /api/v1/vacations/create
Что делает: создает отпускные дни и отправляет их на согласование.
Path: нет
Query: нет
Body: JSON

{
  "year": 2026,
  "days": ["2026-07-14", "2026-07-15", "2026-07-16"],
  "approver_ids": [41],
  "comment": "Летний отпуск"
}

Полный каталог методов

Ниже собран полный список маршрутов в одном формате. Слева вы видите метод и путь, справа — краткое назначение и то, какие параметры обычно используются.

Провайдеры

PUT /api/v1/providers/clear/storage — очистить хранилище активности. Body: JSON.
GET /api/v1/providers/contacts/users — найти пользователей активности. Query: обычно page, size, search, sort, date_from, date_to.
PUT /api/v1/providers/create/employee — привязать сотрудника к активности. Body: JSON.
POST /api/v1/providers/division/create — создать подразделение. Body: JSON.
DELETE /api/v1/providers/division/{division_id} — удалить подразделение. Path: division_id. Body: JSON.
GET /api/v1/providers/division/{division_id} — получить подразделение. Path: division_id. Query: обычно page, size, search, sort, date_from, date_to.
PATCH /api/v1/providers/division/{division_id} — обновить подразделение. Path: division_id. Body: JSON.
GET /api/v1/providers/division/{division_id}/ids — получить ID сотрудников подразделения. Path: division_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/providers/division/{division_id}/users — получить сотрудников подразделения. Path: division_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/providers/divisions — получить список подразделений. Query: обычно page, size, search, sort, date_from, date_to.
PATCH /api/v1/providers/employee/contacts — обновить контакты сотрудника. Body: JSON.
PATCH /api/v1/providers/employee/preview — обновить превью сотрудника. Body: JSON.
GET /api/v1/providers/lite/user/{user_id} — получить краткую карточку пользователя. Path: user_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/providers/lite/users — получить краткий список пользователей. Query: обычно page, size, search, sort, date_from, date_to.
POST /api/v1/providers/lite/users — получить краткий список пользователей по фильтрам. Body: JSON.
GET /api/v1/providers/parameters — получить параметры активности. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/providers/parent/users/{role_id} — получить пользователей дочерних ролей. Path: role_id. Query: обычно page, size, search, sort, date_from, date_to.
POST /api/v1/providers/position/create — создать должность или ставку. Body: JSON.
DELETE /api/v1/providers/position/{position_id} — удалить должность или ставку. Path: position_id. Body: JSON.
GET /api/v1/providers/position/{position_id} — получить должность или ставку. Path: position_id. Query: обычно page, size, search, sort, date_from, date_to.
PATCH /api/v1/providers/position/{position_id} — обновить должность или ставку. Path: position_id. Body: JSON.
GET /api/v1/providers/position/{position_id}/users — получить сотрудников ставки. Path: position_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/providers/positions/{division_id} — получить ставки по отделу. Path: division_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/providers/profiles/count — получить количество профилей сотрудников. Query: обычно page, size, search, sort, date_from, date_to.
POST /api/v1/providers/roles/add — создать роль. Body: JSON.
GET /api/v1/providers/roles/contain/{role_id} — получить дочерние роли. Path: role_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/providers/roles/permissions — получить список системных прав. Query: обычно page, size, search, sort, date_from, date_to.
DELETE /api/v1/providers/roles/remove/{role_id} — удалить роль. Path: role_id. Body: JSON.
GET /api/v1/providers/roles/role/{role_id} — получить роль. Path: role_id. Query: обычно page, size, search, sort, date_from, date_to.
PATCH /api/v1/providers/roles/update/{role_id} — обновить роль. Path: role_id. Body: JSON.
GET /api/v1/providers/roles/users/{role_id} — получить пользователей роли. Path: role_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/providers/roles/{provider_id} — получить роли активности. Path: provider_id. Query: обычно page, size, search, sort, date_from, date_to.
POST /api/v1/providers/roles/sync-root — синхронизировать корневую роль с системными правами. Body: JSON.
GET /api/v1/providers/roles/custom-permissions — получить список своих прав доступа. Query: обычно page, size, search, sort.
POST /api/v1/providers/roles/custom-permissions — создать свое право доступа. Body: JSON.
PATCH /api/v1/providers/roles/custom-permissions/{value} — обновить свое право доступа. Path: value. Body: JSON.
DELETE /api/v1/providers/roles/custom-permissions/{value} — удалить свое право доступа. Path: value.
PATCH /api/v1/providers/update/employee/{profile_id} — обновить профиль сотрудника. Path: profile_id. Body: JSON.
PATCH /api/v1/providers/user/blocked/{profile_id} — заблокировать или разблокировать сотрудника. Path: profile_id. Body: JSON.
GET /api/v1/providers/user/params/{provider_id} — получить параметры активности и provider token. Path: provider_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/providers/user/profile/by-user/{user_id} — получить профиль сотрудника по user_id. Path: user_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/providers/user/profile/{profile_id} — получить профиль сотрудника по profile_id. Path: profile_id. Query: обычно page, size, search, sort, date_from, date_to.
DELETE /api/v1/providers/user/{profile_id} — удалить профиль сотрудника. Path: profile_id. Body: JSON.

Учет времени

GET /api/v1/tm/active/{provider_id} — получить активную сессию в активности. Path: provider_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/chart/amount — получить сводку по отработанному времени. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/chart/amount/role/{role_id} — получить сводку по роли. Path: role_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/chart/amount/users — получить сводку по пользователям. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/chart/statistic — получить статистику по времени. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/chart/statistic/role/{role_id} — получить статистику по роли. Path: role_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/chart/statistic/users — получить статистику по пользователям. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/current/{profile_id} — получить текущую сессию сотрудника. Path: profile_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/day/{date} — получить рабочие сессии за день. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/day/{date}/role/{role_id} — получить сессии по роли за день. Path: date, role_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/day/{date}/users — получить сессии сотрудников за день. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/export — экспортировать данные по времени. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/latest/{profile_id} — получить последнюю сессию сотрудника. Path: profile_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/list/{profile_id} — получить список сессий сотрудника. Path: profile_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/month/{date} — получить сессии за месяц. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/month/{date}/role/{role_id} — получить сессии роли за месяц. Path: date, role_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/month/{date}/users — получить сессии сотрудников за месяц. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/rating/users — получить рейтинг сотрудников. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/session/{session_id} — получить конкретную сессию. Path: session_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/statistic/{profile_id} — получить статистику сотрудника. Path: profile_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/week/{date} — получить сессии за неделю. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/week/{date}/role/{role_id} — получить сессии роли за неделю. Path: date, role_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tm/week/{date}/users — получить сессии сотрудников за неделю. Path: date. Query: обычно page, size, search, sort, date_from, date_to.

Отчеты

POST /api/v1/reports/create — создать отчет. Body: JSON.
GET /api/v1/reports/date/{date} — получить отчеты за день. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/reports/employees/{date} — получить отчеты сотрудников за день. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/reports/list/{profile_id} — получить список отчетов сотрудника. Path: profile_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/reports/month/{date} — получить отчеты за месяц. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/reports/role/{role_id} — получить отчеты по роли. Path: role_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/reports/statistic/{profile_id} — получить статистику отчетов сотрудника. Path: profile_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/reports/today — получить отчеты за сегодня. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/reports/week/{date} — получить отчеты за неделю. Path: date. Query: обычно page, size, search, sort, date_from, date_to.

Задачи

POST /api/v1/tasks/create — создать задачу. Body: JSON.
GET /api/v1/tasks/list — получить список задач. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tasks/day/{date} — получить задачи за день. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tasks/month/{date} — получить задачи за месяц. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tasks/week/{date} — получить задачи за неделю. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tasks/task/{task_id} — получить карточку задачи. Path: task_id. Query: обычно page, size, search, sort, date_from, date_to.
PATCH /api/v1/tasks/status/{task_id} — обновить статус задачи. Path: task_id. Body: JSON.
PATCH /api/v1/tasks/update/{task_id} — обновить задачу. Path: task_id. Body: JSON.
PATCH /api/v1/tasks/checklist/{task_id} — обновить чек-лист задачи. Path: task_id. Body: JSON.
GET /api/v1/tasks/chart/statistic — получить статистику задач. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tasks/chart/statistic/role/{role_id} — получить статистику задач по роли. Path: role_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tasks/chart/statistic/users — получить статистику задач по сотрудникам. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tasks/priorities — получить список приоритетов задач. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tasks/statuses — получить список статусов задач. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tasks/role/{role_id} — получить задачи роли. Path: role_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/tasks/user/{profile_id} — получить задачи сотрудника. Path: profile_id. Query: обычно page, size, search, sort, date_from, date_to.

Заявки

POST /api/v1/requests/template/create — создать шаблон заявки. Body: JSON.
PATCH /api/v1/requests/template/update — обновить шаблон заявки. Query: id. Body: JSON.
PATCH /api/v1/requests/template/archive — архивировать или вернуть шаблон заявки. Query: id. Body: JSON.
DELETE /api/v1/requests/template/delete — удалить шаблон заявки. Query: id.
GET /api/v1/requests/template — получить шаблон заявки по ID. Query: id.
GET /api/v1/requests/templates — получить список шаблонов заявок. Query: обычно page, size, search, sort, archived.
POST /api/v1/requests/create — создать заявку. Body: JSON.
PATCH /api/v1/requests/approve — согласовать или отклонить заявку. Query: id. Body: JSON.
GET /api/v1/requests/item — получить заявку по ID. Query: id.
GET /api/v1/requests/items — получить список заявок. Query: обычно page, size, search, sort, status, template_id.
GET /api/v1/requests/templates/lite — получить короткий список шаблонов заявок. Query: обычно page, size, search, sort.

Инциденты

POST /api/v1/incidents/template/create — создать шаблон инцидента. Body: JSON.
GET /api/v1/incidents/templates — получить шаблоны инцидентов. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/incidents/template/{template_id} — получить шаблон инцидента по ID. Path: template_id. Query: обычно page, size, search, sort, date_from, date_to.
PATCH /api/v1/incidents/template/{template_id} — обновить шаблон инцидента. Path: template_id. Body: JSON.
DELETE /api/v1/incidents/template/{template_id} — удалить шаблон инцидента. Path: template_id. Body: JSON.
POST /api/v1/incidents/create — создать инцидент. Body: JSON.
GET /api/v1/incidents/list — получить список инцидентов. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/incidents/day/{date} — получить инциденты за день. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/incidents/week/{date} — получить инциденты за неделю. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/incidents/month/{date} — получить инциденты за месяц. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/incidents/card/{incident_number} — получить карточку инцидента. Path: incident_number. Query: обычно page, size, search, sort, date_from, date_to.
PATCH /api/v1/incidents/status/{incident_number} — обновить статус инцидента. Path: incident_number. Body: JSON.
GET /api/v1/incidents/priorities — получить приоритеты инцидентов. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/incidents/statuses — получить статусы инцидентов. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/incidents/chart/statistic — получить статистику по инцидентам. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/incidents/chart/statistic/role/{role_id} — получить статистику инцидентов по роли. Path: role_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/incidents/chart/statistic/users — получить статистику инцидентов по сотрудникам. Query: обычно page, size, search, sort, date_from, date_to.

Календарь

POST /api/v1/calendar/create — создать событие. Body: JSON.
GET /api/v1/calendar/date/{date} — получить события за дату. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
DELETE /api/v1/calendar/delete/{event_id} — удалить событие. Path: event_id. Body: JSON.
GET /api/v1/calendar/holidays/{year} — получить производственный календарь праздников. Path: year.
GET /api/v1/calendar/intersections — получить пересечения событий. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/calendar/list — получить список событий. Query: обычно page, size, search, sort, date_from, date_to.
PATCH /api/v1/calendar/update/{event_id} — обновить событие. Path: event_id. Body: JSON.
GET /api/v1/calendar/{event_id} — получить событие по ID. Path: event_id. Query: обычно page, size, search, sort, date_from, date_to.

Отпуска

POST /api/v1/vacations/create — создать отпускной план. Body: JSON.
GET /api/v1/vacations/balance — получить остаток отпускных дней. Query: обычно page, size, search, sort, year.
GET /api/v1/vacations/intersections — получить пересечения отпусков. Query: обычно page, size, search, sort, year.
GET /api/v1/vacations/list — получить список отпусков. Query: обычно page, size, search, sort, year.
GET /api/v1/vacations/next/date — получить ближайшую отпускную дату. Query: user_id.
GET /api/v1/vacations/settings — получить настройки отпуска. Query: обычно page, size, search, sort.
PATCH /api/v1/vacations/settings — обновить настройки отпуска. Body: JSON.
GET /api/v1/vacations/user/days/{user_id} — получить отпускные дни сотрудника. Path: user_id. Query: обычно page, size, search, sort, year.
GET /api/v1/vacations/users/days — получить отпускные дни нескольких сотрудников. Query: обычно page, size, search, sort, year.
GET /api/v1/vacations/year/{year} — получить отпускной план за год. Path: year. Query: обычно page, size, search, sort.
PATCH /api/v1/vacations/approve/{user_id} — согласовать отпускной план сотрудника. Path: user_id. Body: JSON.
PATCH /api/v1/vacations/day/{vacation_id} — обновить отпускной день. Path: vacation_id. Body: JSON.
DELETE /api/v1/vacations/day/{vacation_id} — удалить отпускной день. Path: vacation_id. Body: JSON.
POST /api/v1/vacations/carryover/upsert — сохранить перенос отпускных дней. Body: JSON.
POST /api/v1/vacations/carryover/auto — автоматически распределить перенос отпускных дней. Body: JSON.
GET /api/v1/vacations/carryover/list — получить список переносов отпусков. Query: обычно page, size, search, sort, year.
GET /api/v1/vacations/carryover/balance — получить баланс переносов отпусков. Query: обычно page, size, search, sort, year.

Чек-листы

POST /api/v1/checklist/create — создать шаблон чек-листа. Body: JSON.
POST /api/v1/checklist/run — запустить чек-лист. Body: JSON.
POST /api/v1/checklist/answer — ответить на элемент чек-листа. Body: JSON.
GET /api/v1/checklist/item/{id} — получить шаблон чек-листа по ID. Path: id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/checklist/list — получить шаблоны чек-листов. Query: обычно page, size, search, sort, date_from, date_to.
PATCH /api/v1/checklist/update/{id} — обновить шаблон чек-листа. Path: id. Body: JSON.
DELETE /api/v1/checklist/delete/{id} — удалить шаблон чек-листа. Path: id. Body: JSON.
GET /api/v1/checklist/runs — получить запуски чек-листов. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/checklist/run/{id} — получить запуск чек-листа по ID. Path: id. Query: обычно page, size, search, sort, date_from, date_to.
PATCH /api/v1/checklist/archive/{id} — архивировать или вернуть шаблон чек-листа. Path: id. Body: JSON.
GET /api/v1/checklist/statistic/{id} — получить статистику по шаблону чек-листа. Path: id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/checklist/chart/statistic — получить статистику чек-листов. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/checklist/chart/statistic/role/{role_id} — получить статистику чек-листов по роли. Path: role_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/checklist/chart/statistic/users — получить статистику чек-листов по сотрудникам. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/checklist/day/{date} — получить чек-листы за день. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/checklist/week/{date} — получить чек-листы за неделю. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/checklist/month/{date} — получить чек-листы за месяц. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/checklist/linked/task/{task_id} — получить чек-листы, связанные с задачей. Path: task_id. Query: обычно page, size, search, sort, date_from, date_to.

Бланки и опросы

POST /api/v1/forms/create — создать форму или опрос. Body: JSON.
PATCH /api/v1/forms/update/{id} — обновить форму или опрос. Path: id. Body: JSON.
DELETE /api/v1/forms/delete/{id} — удалить форму или опрос. Path: id. Body: JSON.
GET /api/v1/forms/list — получить список форм и опросов. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/forms/item/{id} — получить форму по ID. Path: id. Query: обычно page, size, search, sort, date_from, date_to.
POST /api/v1/forms/run — запустить форму. Body: JSON.
GET /api/v1/forms/runs — получить запуски форм. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/forms/run/{id} — получить запуск формы по ID. Path: id. Query: обычно page, size, search, sort, date_from, date_to.
POST /api/v1/forms/answer — отправить ответы по форме. Body: JSON.
PATCH /api/v1/forms/archive/{id} — архивировать или вернуть форму. Path: id. Body: JSON.
GET /api/v1/forms/chart/statistic — получить статистику форм. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/forms/chart/statistic/role/{role_id} — получить статистику форм по роли. Path: role_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/forms/chart/statistic/users — получить статистику форм по сотрудникам. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/forms/day/{date} — получить формы за день. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/forms/week/{date} — получить формы за неделю. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/forms/month/{date} — получить формы за месяц. Path: date. Query: обычно page, size, search, sort, date_from, date_to.

База знаний

POST /api/v1/wiki/create — создать статью базы знаний. Body: JSON.
PATCH /api/v1/wiki/update/{id} — обновить статью базы знаний. Path: id. Body: JSON.
DELETE /api/v1/wiki/delete/{id} — удалить статью базы знаний. Path: id. Body: JSON.
GET /api/v1/wiki/list — получить список статей. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/wiki/item/{id} — получить статью по ID. Path: id. Query: обычно page, size, search, sort, date_from, date_to.
PATCH /api/v1/wiki/archive/{id} — архивировать или вернуть статью. Path: id. Body: JSON.
GET /api/v1/wiki/chart/statistic — получить статистику базы знаний. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/wiki/chart/statistic/role/{role_id} — получить статистику статей по роли. Path: role_id. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/wiki/chart/statistic/users — получить статистику статей по сотрудникам. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/wiki/day/{date} — получить статьи за день. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/wiki/week/{date} — получить статьи за неделю. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/wiki/month/{date} — получить статьи за месяц. Path: date. Query: обычно page, size, search, sort, date_from, date_to.
GET /api/v1/wiki/parents — получить родительские разделы базы знаний. Query: обычно page, size, search, sort.
GET /api/v1/wiki/children/{id} — получить дочерние статьи или разделы. Path: id. Query: обычно page, size, search, sort.
GET /api/v1/wiki/search — найти статьи базы знаний. Query: обычно page, size, search, sort.

Документы

POST /api/v1/documents/dispatch/create — создать отправку документа на подпись. Body: JSON.
GET /api/v1/documents/source/meta — получить метаданные исходного документа. Query: обычно page, size, search, sort.
GET /api/v1/documents/created — получить документы, созданные пользователем. Query: обычно page, size, search, sort.
GET /api/v1/documents/assigned — получить документы, назначенные пользователю. Query: обычно page, size, search, sort.
GET /api/v1/documents/completed — получить завершенные документы. Query: обычно page, size, search, sort.
GET /api/v1/documents/dispatch — получить отправки документов на подпись. Query: обычно page, size, search, sort.
POST /api/v1/documents/dispatch/sign — подписать документ. Body: JSON.

AI-ассистент

POST /api/v1/ai/assistant/message — отправить сообщение AI-ассистенту. Body: JSON.

Как пользоваться этим документом

Если вы строите интеграцию под конкретный сценарий, лучше идти так:

сначала определить бизнес-процесс;
найти нужный раздел в каталоге методов;
взять основной create или update метод;
проверить результат в интерфейсе Synchra.24;
только потом добавлять списки, фильтры и синхронизацию в обе стороны.

Так интеграция запускается быстрее и без лишней сложности на старте.

rocket_launch30 дней бесплатно

Попробуйте Synchra24 на своей команде без риска

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