Главная / Документация / APIAPI: задачи, план и совместная работаМаршруты плана проекта, задач, приемки, комментариев, досок, импорта из Битрикс24 и MS Project в volrix.pm: права, тела запросов и примеры.Обновлено 16.10.2026Группа описывает работу внутри проекта: задачи плана (диаграмма Ганта) с датами, связями и прогрессом, назначения исполнителей, сдачу и приемку результата, чек-листы, комментарии и вложения, доски (в том числе загрузка задач из Битрикс24 на доску) и перенос плана из MS Project.**Что принимает API-ключ.** Доски, связи карточек с CRM и импорт из Битрикс24 (скоупы boards:...) и карточка задачи с чек-листом (/project-tasks, скоуп project_tasks:read). Задачи плана, назначения, приемка, комментарии и импорт проверяют участие в проекте и работают только в сессии пользователя.Базовый адрес, формат ответов и коды ошибок описаны в статье API: адрес, первый запрос и ответы, выпуск ключа и вход под пользователем - в статье API: вход, токен и API-ключи. В примерах ключ лежит в переменной окружения VOLRIX_API_KEY, токен пользователя - в VOLRIX_TOKEN.Типовой сценарий: задача от создания до приемки

Прочитайте план GET /api/v1/projects/{project_id}/tasks - задачи плана проекта; плоский список со статусом и признаком просрочки - GET .../tasks-flat.

Создайте задачу POST /api/v1/projects/{project_id}/tasks с телом TaskCreate. Обязательны name, responsible_id, planned_start и planned_end; parent_id делает задачу вложенной, predecessors задает связи.

Отметьте прогресс PATCH .../tasks/{task_id}/progress с телом {"progress": 50}. Точечные PATCH меняют одно поле и не трогают остальные.

Сдайте результат Исполнитель вызывает POST .../tasks/{task_id}/submit-for-acceptance. Задача переходит в pending_acceptance.

Примите или верните Принимающий вызывает POST .../accept (задача становится completed) или POST .../return с телом {"comment": "..."} (снова in_progress). История - GET .../acceptance-log.

Для сдачи результата используйте маршруты приемки, а не PATCH .../status: переходы приемки попадают в журнал acceptance-log.Комментарии и вложения общие для нескольких сущностей: /api/v1/{target_type}/{target_id}/comments и /attachments, где target_type - project_task, order, board_card, storage_node или deal.Примеры запросовМои задачи по всем проектам (сессия). Каждый элемент содержит проект, статус с подписью, плановые даты и признак is_overdue:curl --fail-with-body -sS \ -H "Authorization: Bearer $VOLRIX_TOKEN" \ "https://ваш-адрес/api/v1/me/tasks-flat"Импорт плана из MS Project в два шага (сессия): предпросмотр принимает файл .xml (MS Project XML) или .mpp и возвращает preview_token, подтверждение применяет его. strategy - replace (по умолчанию) или append:curl --fail-with-body -sS -X POST \ -H "Authorization: Bearer $VOLRIX_TOKEN" \ -F "file=@plan.xml" \ "https://ваш-адрес/api/v1/projects/{project_id}/tasks/import-msproject/preview" curl --fail-with-body -sS -X POST \ -H "Authorization: Bearer $VOLRIX_TOKEN" \ -H "Content-Type: application/json" \ -d '{"preview_token": "...", "strategy": "append"}' \ "https://ваш-адрес/api/v1/projects/{project_id}/tasks/import-msproject/confirm"Доски проекта по ключу (скоуп boards:read):curl --fail-with-body -sS \ -H "X-Api-Key: $VOLRIX_API_KEY" \ "https://ваш-адрес/api/v1/boards?project_id=7b1e..."Загрузка задач из Битрикс24 на доску в два шага (скоуп boards:update, у сотрудника - право boards.update и роль «редактор» на доске). Оба запроса получают один и тот же файл выгрузки «Экспорт в Excel»: предпросмотр ничего не пишет и возвращает, как сервер сопоставил статусы, людей и записи CRM, а загрузка применяет решения из поля options (JSON). Чего в options нет, сервер подбирает так же, как в предпросмотре:curl --fail-with-body -sS -X POST \ -H "X-Api-Key: $VOLRIX_API_KEY" \ -F "file=@tasks.xls" \ "https://ваш-адрес/api/v1/boards/{board_id}/import/bitrix/preview" curl --fail-with-body -sS -X POST \ -H "X-Api-Key: $VOLRIX_API_KEY" \ -F "file=@tasks.xls" \ -F 'options={"statuses": [{"status": "В работе", "new_column_name": "В работе"}], "project_labels": true}' \ "https://ваш-адрес/api/v1/boards/{board_id}/import/bitrix"МаршрутыКак читать колонку «Доступ»: **скоуп вида users:read** - маршрут принимает API-ключ, если в ключе есть этот скоуп, а у сотрудника, выпустившего ключ, есть такое же право в роли (users.read). Если скоупов несколько через «+», нужны все. **Только сессия** - нужен заголовок Authorization: Bearer, API-ключ получит 403. **Без авторизации** - заголовки не нужны. Доступ к конкретному объекту (участие в проекте, права на папку Диска) сервер проверяет дополнительно. Пути в таблицах указаны полностью, от корня сервера.Задачи плана проекта

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/projects/{project_id}/tasks

project_id [path обяз.]: string (uuid); baseline_id [query]: string (uuid) / null

Только сессия

200: object

POST /api/v1/projects/{project_id}/tasks

project_id [path обяз.]: string (uuid) | Тело: application/json: TaskCreate

Только сессия

201: object

POST /api/v1/projects/{project_id}/tasks/recalculate-overdue

project_id [path обяз.]: string (uuid)

Только сессия

200: object

GET /api/v1/projects/{project_id}/tasks/{task_id}

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid)

Только сессия

200: object

PUT /api/v1/projects/{project_id}/tasks/{task_id}

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid) | Тело: application/json: TaskUpdate

Только сессия

200: object

DELETE /api/v1/projects/{project_id}/tasks/{task_id}

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid)

Только сессия

200: object

PATCH /api/v1/projects/{project_id}/tasks/{task_id}/name

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid) | Тело: application/json: NameUpdate

Только сессия

200: object

PATCH /api/v1/projects/{project_id}/tasks/{task_id}/planned-dates

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid) | Тело: application/json: DatesUpdate

Только сессия

200: object

PATCH /api/v1/projects/{project_id}/tasks/{task_id}/planned-start

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid) | Тело: application/json: StartUpdate

Только сессия

200: object

PATCH /api/v1/projects/{project_id}/tasks/{task_id}/planned-end

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid) | Тело: application/json: EndUpdate

Только сессия

200: object

PATCH /api/v1/projects/{project_id}/tasks/{task_id}/planned-duration

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid) | Тело: application/json: DurationUpdate

Только сессия

200: object

PATCH /api/v1/projects/{project_id}/tasks/{task_id}/responsible

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid) | Тело: application/json: ResponsibleUpdate

Только сессия

200: object

PATCH /api/v1/projects/{project_id}/tasks/{task_id}/task-type

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid) | Тело: application/json: TaskTypeUpdate

Только сессия

200: object

PATCH /api/v1/projects/{project_id}/tasks/{task_id}/scheduling-mode

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid) | Тело: application/json: SchedulingModeUpdate

Только сессия

200: object

PATCH /api/v1/projects/{project_id}/tasks/{task_id}/predecessors

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid) | Тело: application/json: PredecessorsUpdate

Только сессия

200: object

PATCH /api/v1/projects/{project_id}/tasks/{task_id}/predecessors-text

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid) | Тело: application/json: PredecessorsTextUpdate

Только сессия

200: object

PATCH /api/v1/projects/{project_id}/tasks/{task_id}/progress

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid) | Тело: application/json: ProgressUpdate

Только сессия

200: object

PATCH /api/v1/projects/{project_id}/tasks/{task_id}/status

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid) | Тело: application/json: StatusUpdate

Только сессия

200: object

POST /api/v1/projects/{project_id}/tasks/{task_id}/indent

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid)

Только сессия

200: object

POST /api/v1/projects/{project_id}/tasks/{task_id}/outdent

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid)

Только сессия

200: object

POST /api/v1/projects/{project_id}/tasks/{task_id}/reorder

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid) | Тело: application/json: ReorderRequest

Только сессия

200: object

PUT /api/v1/projects/{project_id}/tasks/{task_id}/move

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid); direction [query обяз.]: string

Только сессия

200: object

POST /api/v1/projects/{project_id}/tasks/bulk-distribute

project_id [path обяз.]: string (uuid) | Тело: application/json: BulkIds

Только сессия

200: object

POST /api/v1/projects/{project_id}/tasks/bulk-delete

project_id [path обяз.]: string (uuid) | Тело: application/json: BulkIds

Только сессия

200: object

POST /api/v1/projects/{project_id}/tasks/bulk-status

project_id [path обяз.]: string (uuid) | Тело: application/json: BulkStatus

Только сессия

200: object

Плоские списки задач

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/projects/{project_id}/tasks-flat

project_id [path обяз.]: string (uuid)

Только сессия

200: array[TaskFlatItem]

GET /api/v1/me/tasks-flat

Нет

Только сессия

200: array[TaskFlatItem]

Назначения на задачи

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/task-assignments/mode

Нет

Только сессия

200: ModeRead

PUT /api/v1/task-assignments/mode

Нет | Тело: application/json: ModeUpdate

Только сессия

200: ModeRead

GET /api/v1/task-assignments

task_id [query обяз.]: string (uuid)

Только сессия

200: array[AssignmentRead]

POST /api/v1/task-assignments

Нет | Тело: application/json: AssignmentCreate

Только сессия

201: AssignmentRead

DELETE /api/v1/task-assignments/{assignment_id}

assignment_id [path обяз.]: string (uuid)

Только сессия

204

Сдача и приемка задач

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

POST /api/v1/projects/{project_id}/tasks/{task_id}/submit-for-acceptance

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid)

Только сессия

200: object

POST /api/v1/projects/{project_id}/tasks/{task_id}/accept

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid)

Только сессия

200: object

POST /api/v1/projects/{project_id}/tasks/{task_id}/return

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid) | Тело: application/json: TaskReturnRequest

Только сессия

200: object

GET /api/v1/projects/{project_id}/tasks/{task_id}/acceptance-log

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid)

Только сессия

200: array[TaskAcceptanceLogRead]

GET /api/v1/projects/{project_id}/tasks/{task_id}/dependent-tasks

project_id [path обяз.]: string (uuid); task_id [path обяз.]: string (uuid)

Только сессия

200: TaskAcceptanceReturnPreview

Карточка задачи и чек-лист

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/project-tasks/{task_id}

task_id [path обяз.]: string (uuid)

project_tasks:read

200: object

GET /api/v1/project-tasks/{task_id}/checklist

task_id [path обяз.]: string (uuid)

project_tasks:read

200: object

POST /api/v1/project-tasks/{task_id}/checklist

task_id [path обяз.]: string (uuid) | Тело: application/json: ChecklistCreate

project_tasks:read

201: object

PUT /api/v1/project-tasks/{task_id}/checklist/{item_id}

task_id [path обяз.]: string (uuid); item_id [path обяз.]: string (uuid) | Тело: application/json: ChecklistUpdate

project_tasks:read

200: object

DELETE /api/v1/project-tasks/{task_id}/checklist/{item_id}

task_id [path обяз.]: string (uuid); item_id [path обяз.]: string (uuid)

project_tasks:read

204

Комментарии и вложения

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/{target_type}/{target_id}/comments

target_type [path обяз.]: string: project_task, order, board_card, storage_node, deal; target_id [path обяз.]: string (uuid)

Только сессия

200: array[TaskCommentRead]

POST /api/v1/{target_type}/{target_id}/comments

target_type [path обяз.]: string: project_task, order, board_card, storage_node, deal; target_id [path обяз.]: string (uuid) | Тело: application/json: TaskCommentCreate

Только сессия

201: TaskCommentRead

PUT /api/v1/{target_type}/{target_id}/comments/{comment_id}

target_type [path обяз.]: string: project_task, order, board_card, storage_node, deal; target_id [path обяз.]: string (uuid); comment_id [path обяз.]: string (uuid) | Тело: application/json: TaskCommentUpdate

Только сессия

200: TaskCommentRead

DELETE /api/v1/{target_type}/{target_id}/comments/{comment_id}

target_type [path обяз.]: string: project_task, order, board_card, storage_node, deal; target_id [path обяз.]: string (uuid); comment_id [path обяз.]: string (uuid)

Только сессия

200: object

GET /api/v1/{target_type}/{target_id}/attachments

target_type [path обяз.]: string: project_task, order, board_card, storage_node, deal; target_id [path обяз.]: string (uuid)

Только сессия

200: array[TaskAttachmentRead]

POST /api/v1/{target_type}/{target_id}/attachments

target_type [path обяз.]: string: project_task, order, board_card, storage_node, deal; target_id [path обяз.]: string (uuid) | Тело: multipart/form-data: Body_upload_attachment_api_v1__target_type___target_id__attachments_post

Только сессия

201: TaskAttachmentRead

GET /api/v1/{target_type}/{target_id}/attachments/{attachment_id}/download

target_type [path обяз.]: string: project_task, order, board_card, storage_node, deal; target_id [path обяз.]: string (uuid); attachment_id [path обяз.]: string (uuid)

Только сессия

200: object

DELETE /api/v1/{target_type}/{target_id}/attachments/{attachment_id}

target_type [path обяз.]: string: project_task, order, board_card, storage_node, deal; target_id [path обяз.]: string (uuid); attachment_id [path обяз.]: string (uuid)

Только сессия

200: object

GET /api/v1/project_task/{task_id}/predecessor-results

task_id [path обяз.]: string (uuid)

Только сессия

200: object

POST /api/v1/project_task/{task_id}/accept-attachment

task_id [path обяз.]: string (uuid) | Тело: application/json: AcceptAttachmentBody

Только сессия

200: object

Доски

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/boards

project_id [query]: string (uuid) / null; archived [query]: boolean (default=false)

boards:read

200: array[BoardListItem]

POST /api/v1/boards

Нет | Тело: application/json: BoardCreate

boards:create

200: BoardDetail

GET /api/v1/boards/{board_id}

board_id [path обяз.]: string (uuid)

boards:read

200: BoardDetail

PATCH /api/v1/boards/{board_id}

board_id [path обяз.]: string (uuid) | Тело: application/json: BoardUpdate

boards:update

200: BoardDetail

DELETE /api/v1/boards/{board_id}

board_id [path обяз.]: string (uuid)

boards:delete

200: object

POST /api/v1/boards/{board_id}/background

board_id [path обяз.]: string (uuid) | Тело: multipart/form-data: Body_upload_board_background_api_v1_boards__board_id__background_post

boards:update

200: BoardDetail

PUT /api/v1/boards/{board_id}/members

board_id [path обяз.]: string (uuid) | Тело: application/json: MemberSet

boards:update

200: BoardDetail

DELETE /api/v1/boards/{board_id}/members/{person_id}

board_id [path обяз.]: string (uuid); person_id [path обяз.]: string (uuid)

boards:update

200: BoardDetail

POST /api/v1/boards/{board_id}/columns

board_id [path обяз.]: string (uuid) | Тело: application/json: ColumnCreate

boards:update

200: BoardDetail

PATCH /api/v1/board-columns/{column_id}

column_id [path обяз.]: string (uuid) | Тело: application/json: ColumnUpdate

boards:update

200: BoardDetail

DELETE /api/v1/board-columns/{column_id}

column_id [path обяз.]: string (uuid)

boards:update

200: BoardDetail

POST /api/v1/boards/{board_id}/columns/reorder

board_id [path обяз.]: string (uuid) | Тело: application/json: ColumnReorder

boards:update

200: BoardDetail

POST /api/v1/boards/{board_id}/cards

board_id [path обяз.]: string (uuid) | Тело: application/json: CardCreate

boards:update

200: CardDetail

GET /api/v1/board-cards/{card_id}

card_id [path обяз.]: string (uuid)

boards:read

200: CardDetail

PATCH /api/v1/board-cards/{card_id}

card_id [path обяз.]: string (uuid) | Тело: application/json: CardUpdate

boards:update

200: CardDetail

DELETE /api/v1/board-cards/{card_id}

card_id [path обяз.]: string (uuid)

boards:update

200: object

POST /api/v1/board-cards/{card_id}/move

card_id [path обяз.]: string (uuid) | Тело: application/json: CardMove

boards:update

200: object

POST /api/v1/board-cards/{card_id}/archive

card_id [path обяз.]: string (uuid)

boards:update

200: object

POST /api/v1/board-cards/{card_id}/unarchive

card_id [path обяз.]: string (uuid)

boards:update

200: object

POST /api/v1/board-columns/{column_id}/archive-cards

column_id [path обяз.]: string (uuid)

boards:update

200: BoardDetail

POST /api/v1/boards/{board_id}/archive-cards

board_id [path обяз.]: string (uuid)

boards:update

200: BoardDetail

GET /api/v1/boards/{board_id}/archived-cards

board_id [path обяз.]: string (uuid)

boards:read

200: object

POST /api/v1/boards/{board_id}/labels

board_id [path обяз.]: string (uuid) | Тело: application/json: LabelCreate

boards:update

200: BoardDetail

PATCH /api/v1/board-labels/{label_id}

label_id [path обяз.]: string (uuid) | Тело: application/json: LabelUpdate

boards:update

200: BoardDetail

DELETE /api/v1/board-labels/{label_id}

label_id [path обяз.]: string (uuid)

boards:update

200: BoardDetail

POST /api/v1/board-cards/{card_id}/checklist

card_id [path обяз.]: string (uuid) | Тело: application/json: ChecklistItemCreate

boards:update

200: CardDetail

PATCH /api/v1/board-checklist/{item_id}

item_id [path обяз.]: string (uuid) | Тело: application/json: ChecklistItemUpdate

boards:update

200: CardDetail

DELETE /api/v1/board-checklist/{item_id}

item_id [path обяз.]: string (uuid)

boards:update

200: CardDetail

Импорт из Битрикс24 и связи карточек с CRM

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

POST /api/v1/boards/{board_id}/import/bitrix/preview

board_id [path обяз.]: string (uuid) | Тело: multipart/form-data: file

boards:update

200: object

POST /api/v1/boards/{board_id}/import/bitrix

board_id [path обяз.]: string (uuid) | Тело: multipart/form-data: file, options

boards:update

200: object

GET /api/v1/board-crm-lookup

kind [query обяз.]: string (organization, contact, deal или lead); q [query]: string (default="")

boards:read

200: array[object]

POST /api/v1/board-cards/{card_id}/links

card_id [path обяз.]: string (uuid) | Тело: application/json: CardLinkCreate

boards:update

200: CardDetail

DELETE /api/v1/board-card-links/{link_id}

link_id [path обяз.]: string (uuid)

boards:update

200: CardDetail

**Как работает импорт.** Принимается выгрузка Битрикс24 «Экспорт в Excel»: HTML-таблица с расширением .xls, файл .xlsx или CSV, до 10 МБ. Формат сервер определяет по содержимому. В доску сделок задачи не загружаются (ответ 400): ее карточки - это сделки. Предпросмотр возвращает total (сколько задач в файле), existing (сколько уже есть на доске), columns_found и unknown_headers (какие колонки распознаны), первые rows, а также списки statuses (статус -> колонка), people (ФИО -> сотрудник, с candidates), crm (названия компаний, контактов и сделок -> записи CRM), projects, flows, tags, warnings и problems. Поле can_create_people показывает, можно ли создавать сотрудников без входа (нужно право employees.create).Загрузка возвращает created, updated, skipped, построчный отчет rows и списки созданного: created_columns, created_people, created_labels. Задачи опознаются по номеру из Битрикс24 (external_id у карточки), поэтому повторная загрузка той же выгрузки обновляет карточки, а не плодит дубли.**Поиск записи CRM для связи.** GET /board-crm-lookup возвращает до 20 элементов {id, label} и показывает ровно то, что видно человеку в самом разделе: организации - при праве на справочник заказчиков или контрагентов, сделки - по видимости сделок, контакты - общие и личные свои. Значение kind=lead выбирает сделки, ранние стадии идут первыми: отдельной сущности «лид» нет, связь с лидом хранится как связь со сделкой. POST /board-cards/{card_id}/links связывает карточку с найденной записью (повтор той же связи ничего не меняет), DELETE /board-card-links/{link_id} снимает связь. Нет записи - 404 «Запись CRM не найдена», запись вам не видна - 403 «Нет доступа к этой записи CRM».Импорт и экспорт MS Project

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

POST /api/v1/projects/{project_id}/tasks/import-msproject/preview

project_id [path обяз.]: string (uuid) | Тело: multipart/form-data: Body_preview_import_api_v1_projects__project_id__tasks_import_msproject_preview_post

Только сессия

200: ImportPreviewResponse

POST /api/v1/projects/{project_id}/tasks/import-msproject/confirm

project_id [path обяз.]: string (uuid) | Тело: application/json: ConfirmRequest

Только сессия

200: ConfirmResponse

GET /api/v1/projects/{project_id}/tasks/export-msproject

project_id [path обяз.]: string (uuid)

Только сессия

200: object

Диаграмма Ганта в PDF

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

POST /api/v1/projects/{project_id}/gantt/pdf

project_id [path обяз.]: string (uuid) | Тело: application/json: GanttPdfRequest

Только сессия

200: object

Тела запросовПоля JSON и форм multipart из схемы сервера. «Да» - поле обязательно. Ссылка на другую схему (например, array[QCApproverInput]) означает вложенный объект с теми же полями.TaskCreate: POST /projects/{project_id}/tasks

Поле

Обязательно

Тип / значения

Ограничения

name

Да

string

task_type

Нет

TaskType

default="task"

scheduling_mode

Нет

TaskSchedulingMode

default="auto"

responsible_id

Да

string (uuid)

planned_start

Да

string (date)

planned_end

Да

string (date)

parent_id

Нет

string (uuid) / null

predecessors

Нет

array[PredecessorRef]

default=[]

add_to_team

Нет

boolean / null

TaskUpdate: PUT /projects/{project_id}/tasks/{task_id}

Поле

Обязательно

Тип / значения

Ограничения

name

Нет

string / null

task_type

Нет

TaskType / null

scheduling_mode

Нет

TaskSchedulingMode / null

responsible_id

Нет

string (uuid) / null

planned_start

Нет

string (date) / null

planned_end

Нет

string (date) / null

parent_id

Нет

string (uuid) / null

predecessors

Нет

array[PredecessorRef] / null

add_to_team

Нет

boolean / null

NameUpdate: PATCH /projects/{project_id}/tasks/{task_id}/name

Поле

Обязательно

Тип / значения

Ограничения

name

Да

string

DatesUpdate: PATCH /projects/{project_id}/tasks/{task_id}/planned-dates

Поле

Обязательно

Тип / значения

Ограничения

planned_start

Да

string (date)

planned_end

Да

string (date)

StartUpdate: PATCH /projects/{project_id}/tasks/{task_id}/planned-start

Поле

Обязательно

Тип / значения

Ограничения

planned_start

Да

string (date)

EndUpdate: PATCH /projects/{project_id}/tasks/{task_id}/planned-end

Поле

Обязательно

Тип / значения

Ограничения

planned_end

Да

string (date)

DurationUpdate: PATCH /projects/{project_id}/tasks/{task_id}/planned-duration

Поле

Обязательно

Тип / значения

Ограничения

planned_duration

Да

integer

ResponsibleUpdate: PATCH /projects/{project_id}/tasks/{task_id}/responsible

Поле

Обязательно

Тип / значения

Ограничения

responsible_id

Да

string (uuid)

add_to_team

Нет

boolean / null

TaskTypeUpdate: PATCH /projects/{project_id}/tasks/{task_id}/task-type

Поле

Обязательно

Тип / значения

Ограничения

task_type

Да

TaskType

SchedulingModeUpdate: PATCH /projects/{project_id}/tasks/{task_id}/scheduling-mode

Поле

Обязательно

Тип / значения

Ограничения

scheduling_mode

Да

TaskSchedulingMode

PredecessorsUpdate: PATCH /projects/{project_id}/tasks/{task_id}/predecessors

Поле

Обязательно

Тип / значения

Ограничения

predecessors

Да

array[PredecessorRef]

PredecessorsTextUpdate: PATCH /projects/{project_id}/tasks/{task_id}/predecessors-text

Поле

Обязательно

Тип / значения

Ограничения

text

Да

string

ProgressUpdate: PATCH /projects/{project_id}/tasks/{task_id}/progress

Поле

Обязательно

Тип / значения

Ограничения

progress

Да

number

StatusUpdate: PATCH /projects/{project_id}/tasks/{task_id}/status

Поле

Обязательно

Тип / значения

Ограничения

state

Да

TaskState

ReorderRequest: POST /projects/{project_id}/tasks/{task_id}/reorder

Поле

Обязательно

Тип / значения

Ограничения

new_sort_order

Да

integer

new_parent_id

Нет

string (uuid) / null

BulkIds: POST /projects/{project_id}/tasks/bulk-distribute, POST /projects/{project_id}/tasks/bulk-delete

Поле

Обязательно

Тип / значения

Ограничения

task_ids

Да

array[string (uuid)]

BulkStatus: POST /projects/{project_id}/tasks/bulk-status

Поле

Обязательно

Тип / значения

Ограничения

task_ids

Да

array[string (uuid)]

state

Да

TaskState

ModeUpdate: PUT /task-assignments/mode

Поле

Обязательно

Тип / значения

Ограничения

mode

Да

string

AssignmentCreate: POST /task-assignments

Поле

Обязательно

Тип / значения

Ограничения

task_id

Да

string (uuid)

person_id

Да

string (uuid)

planned_hours

Нет

number / string / null

is_billable

Нет

boolean

default=true

is_responsible

Нет

boolean

default=false

TaskReturnRequest: POST /projects/{project_id}/tasks/{task_id}/return

Поле

Обязательно

Тип / значения

Ограничения

comment

Да

string

minLength=10; maxLength=2000

ChecklistCreate: POST /project-tasks/{task_id}/checklist

Поле

Обязательно

Тип / значения

Ограничения

title

Да

string

minLength=1; maxLength=1000

responsible_id

Нет

string (uuid) / null

due_date

Нет

string (date) / null

ChecklistUpdate: PUT /project-tasks/{task_id}/checklist/{item_id}

Поле

Обязательно

Тип / значения

Ограничения

title

Нет

string / null

responsible_id

Нет

string (uuid) / null

due_date

Нет

string (date) / null

status

Нет

string: not_started, in_progress, done, cancelled / null

report

Нет

string / null

TaskCommentCreate: POST /{target_type}/{target_id}/comments

Поле

Обязательно

Тип / значения

Ограничения

text

Да

string

minLength=1; maxLength=10000

parent_id

Нет

string (uuid) / null

TaskCommentUpdate: PUT /{target_type}/{target_id}/comments/{comment_id}

Поле

Обязательно

Тип / значения

Ограничения

text

Да

string

minLength=1; maxLength=10000

Форма multipart: POST /{target_type}/{target_id}/attachments

Поле

Обязательно

Тип / значения

Ограничения

file

Да

string (binary)

AcceptAttachmentBody: POST /project_task/{task_id}/accept-attachment

Поле

Обязательно

Тип / значения

Ограничения

attachment_id

Да

string (uuid)

BoardCreate: POST /boards

Поле

Обязательно

Тип / значения

Ограничения

name

Да

string

minLength=1; maxLength=255

kind

Нет

string

default="kanban"

description

Нет

string / null

color

Нет

string

default="info"

icon

Нет

string / null

visibility

Нет

string

default="public"

project_id

Нет

string (uuid) / null

BoardUpdate: PATCH /boards/{board_id}

Поле

Обязательно

Тип / значения

Ограничения

name

Нет

string / null

description

Нет

string / null

color

Нет

string / null

icon

Нет

string / null

bg_color

Нет

string / null

bg_image

Нет

string / null

visibility

Нет

string / null

project_id

Нет

string (uuid) / null

is_archived

Нет

boolean / null

Форма multipart: POST /boards/{board_id}/background

Поле

Обязательно

Тип / значения

Ограничения

file

Да

string (binary)

MemberSet: PUT /boards/{board_id}/members

Поле

Обязательно

Тип / значения

Ограничения

person_id

Да

string (uuid)

can_edit

Нет

boolean

default=false

ColumnCreate: POST /boards/{board_id}/columns

Поле

Обязательно

Тип / значения

Ограничения

name

Да

string

minLength=1; maxLength=120

color

Нет

string

default="neutral"

wip_limit

Нет

integer / null

ColumnUpdate: PATCH /board-columns/{column_id}

Поле

Обязательно

Тип / значения

Ограничения

name

Нет

string / null

color

Нет

string / null

icon

Нет

string / null

bg_color

Нет

string / null

wip_limit

Нет

integer / null

ColumnReorder: POST /boards/{board_id}/columns/reorder

Поле

Обязательно

Тип / значения

Ограничения

column_ids

Да

array[string (uuid)]

CardCreate: POST /boards/{board_id}/cards

Поле

Обязательно

Тип / значения

Ограничения

column_id

Да

string (uuid)

title

Да

string

minLength=1; maxLength=500

description

Нет

string / null

priority

Нет

string / null

due_date

Нет

string (date) / null

CardUpdate: PATCH /board-cards/{card_id}

Поле

Обязательно

Тип / значения

Ограничения

title

Нет

string / null

description

Нет

string / null

priority

Нет

string / null

start_date

Нет

string (date) / null

due_date

Нет

string (date) / null

cover_color

Нет

string / null

assignee_ids

Нет

array[string (uuid)] / null

label_ids

Нет

array[string (uuid)] / null

reporter_id

Нет

string (uuid) / null

Постановщик; null снимает

due_time

Нет

string / null

Время срока ЧЧ:ММ (по Москве), формат: ^([01][0-9]|2[0-3]):[0-5][0-9]$. Без даты срока не хранится: если due_date снят, время тоже сбрасывается

planned_minutes

Нет

integer / null

Плановая длительность в минутах; от 0 до 10000000

spent_minutes

Нет

integer / null

Затрачено, минуты; от 0 до 10000000

result_mark

Нет

string / null

Оценка результата: positive или negative; null снимает

watcher_ids

Нет

array[string (uuid)] / null

Наблюдатели; повторы убираются, пустой список снимает всех

closed_at

Нет

string (date-time) / null

Время закрытия карточки

crm_note

Нет

string / null

Заметка о связях с CRM, не распознанных при импорте

CardMove: POST /board-cards/{card_id}/move

Поле

Обязательно

Тип / значения

Ограничения

column_id

Да

string (uuid)

sort_order

Да

integer

CardLinkCreate: POST /board-cards/{card_id}/links

Поле

Обязательно

Тип / значения

Ограничения

kind

Да

string

формат: ^(organization|contact|deal|lead)$

target_id

Да

string (uuid)

Форма multipart: POST /boards/{board_id}/import/bitrix/preview

Поле

Обязательно

Тип / значения

Ограничения

file

Да

string (binary)

до 10 МБ

Форма multipart: POST /boards/{board_id}/import/bitrix

Поле

Обязательно

Тип / значения

Ограничения

file

Да

string (binary)

до 10 МБ, тот же файл, что в предпросмотре

options

Нет

string (JSON)

default="{}"; схема BitrixImportOptions ниже. Неверный JSON дает 422 «Неверные параметры импорта»

BitrixImportOptions: поле options

Поле

Обязательно

Тип / значения

Ограничения

statuses

Нет

array[StatusTarget]

Каждый элемент: status (Да, статус из файла), column_id (uuid существующей колонки) или new_column_name (string, до 120 знаков - завести колонку)

people

Нет

array[PersonTarget]

Каждый элемент: name (Да, ФИО из файла), action (Да: person, none или create), person_id (uuid, для action=person). none - не назначать, create - завести сотрудника без входа (право employees.create)

crm

Нет

array[CrmTarget]

Каждый элемент: kind (Да: company, contact, deal или lead), name (Да, название из файла), target_id (uuid записи CRM; без него название останется текстом на карточке)

project_labels

Нет

boolean

default=true; метки из колонки «Проект»

flow_labels

Нет

boolean

default=true; метки из колонки «Поток»

tag_labels

Нет

boolean

default=true; метки из колонки «Теги»

LabelCreate: POST /boards/{board_id}/labels

Поле

Обязательно

Тип / значения

Ограничения

name

Да

string

minLength=1; maxLength=80

color

Нет

string

default="info"

LabelUpdate: PATCH /board-labels/{label_id}

Поле

Обязательно

Тип / значения

Ограничения

name

Нет

string / null

color

Нет

string / null

ChecklistItemCreate: POST /board-cards/{card_id}/checklist

Поле

Обязательно

Тип / значения

Ограничения

text

Да

string

minLength=1; maxLength=500

ChecklistItemUpdate: PATCH /board-checklist/{item_id}

Поле

Обязательно

Тип / значения

Ограничения

text

Нет

string / null

is_done

Нет

boolean / null

Форма multipart: POST /projects/{project_id}/tasks/import-msproject/preview

Поле

Обязательно

Тип / значения

Ограничения

file

Да

string (binary)

ConfirmRequest: POST /projects/{project_id}/tasks/import-msproject/confirm

Поле

Обязательно

Тип / значения

Ограничения

preview_token

Да

string

strategy

Нет

string

default="replace"; формат: ^(replace|append)$

manual_matches

Нет

object

GanttPdfRequest: POST /projects/{project_id}/gantt/pdf

Поле

Обязательно

Тип / значения

Ограничения

svg

Да

string

title

Нет

string / null

Вложенный объект PredecessorRef

Поле

Обязательно

Тип / значения

Ограничения

predecessor_id

Да

string (uuid)

link_type

Нет

TaskLinkType

default="FS"

lag_days

Нет

integer

default=0

Поля ответов досок и карточекПоля ниже появились в версиях 0.111.1 и 0.111.2. В запросах на запись их передают только те, что перечислены в CardUpdate.

Поле

В каком ответе

Что значит

owner_id, owner_name

BoardDetail (GET /boards/{board_id} и ответы записи по доске)

Владелец доски (тот, кто ее завел) и его имя. По ним интерфейс пишет «Доска видна только владельцу (Иванов Иван) и добавленным участникам». owner_name пуст, если у доски нет автора

external_source, external_id, external_label

CardRead, CardDetail

Откуда карточка пришла: bitrix24, номер задачи в источнике и готовая подпись «Битрикс24 #132». Для созданных вручную карточек - null

reporter_id, reporter_name

CardRead, CardDetail

Постановщик

watchers

CardRead, CardDetail

Наблюдатели: массив {person_id, full_name}

due_time, planned_minutes, spent_minutes, result_mark, closed_at, crm_note

CardRead, CardDetail

Время срока ЧЧ:ММ, плановая и затраченная длительность в минутах, оценка результата (positive, negative или null), время закрытия, заметка о связях

links

CardDetail

Связи с CRM: массив {id, kind, target_id, title, subtitle}. kind - organization, contact или deal (лид хранится как deal); subtitle - код и стадия сделки или компания контакта; title пуст, если запись вам недоступна

Правила приватной доски (0.111.2) проверяет сервер. Если редактор переводит чужую общую доску в приватную (PATCH /boards/{board_id}, visibility=private), он в том же запросе становится участником с правом редактирования, иначе доска пропала бы из его списка. Участник приватной доски не может убрать себя (DELETE /boards/{board_id}/members/{person_id}) или снять с себя право редактирования (PUT /boards/{board_id}/members с can_edit=false): ответ 400 «Нельзя ...: вы потеряете доступ к приватной доске. Это может сделать владелец доски». Владельца это не касается.Значения перечислений

Тип

Допустимые значения

TaskLinkType

FS, SS, FF, SF

TaskSchedulingMode

auto, manual

TaskState

not_started, in_progress, pending_acceptance, completed

TaskType

task, milestone

Если не получается

Что видно

Причина и что сделать

403 «API-ключи не поддерживаются на этом эндпоинте»

У маршрута в таблице указано «Только сессия». Выполните его с заголовком Authorization: Bearer от имени сотрудника, см. вход под пользователем.

422 «Неизвестный target_type»

В пути комментариев или вложений указан тип вне списка: project_task, order, board_card, storage_node, deal.

422 при создании задачи

Не хватает name, responsible_id, planned_start или planned_end, либо даты в неверном формате (нужно ГГГГ-ММ-ДД).

422 «Превью устарело или не найдено»

preview_token живет 30 минут в памяти сервера и используется один раз; перезапуск backend его сбрасывает. Повторите предпросмотр и подтвердите новый токен.

403 «API-ключ не имеет права (...)»

В ключе нет скоупа из колонки «Доступ». Скоупы после создания не меняются: выпустите новый ключ с нужным скоупом в «Администрирование» → «Настройки продукта» → «Интеграции» и отзовите старый.

403 «Недостаточно прав (...)»

У пользователя или у сотрудника, выпустившего ключ, нет названного права в роли (с 0.110.6 для ключа проверяются и скоуп, и право владельца). Добавьте право в роль: «Администрирование» → «Доступ» → «Роли и права».

423 на POST, PUT, PATCH или DELETE, чтение работает

Нет действующей лицензии (в ответе license_status: expired, invalid, missing или mismatch). Изменения заблокированы до загрузки файла лицензии, см. Лицензия.

400 «В доску сделок задачи не загружаются» при импорте из Битрикс24

Выбрана системная доска сделок, ее карточки - это сделки. Создайте обычную доску и загрузите выгрузку в нее.

413 «Файл больше 10 МБ. Выгрузите задачи частями.»

Предел размера выгрузки Битрикс24 - 10 МБ. Разбейте экспорт на несколько файлов: повторная загрузка обновляет карточки по номеру задачи, дублей не будет.

422 «Не удалось прочитать файл: в выгрузке нет ни одной задачи.»

Файл не похож на «Экспорт в Excel» из Битрикс24 или в нем нет строк с задачами. Выгрузите список задач заново и проверьте в ответе предпросмотра columns_found и unknown_headers.

400 «Нельзя убрать себя из участников: вы потеряете доступ к приватной доске»

Участник приватной доски не может исключить себя и снять с себя право редактора. Это делает владелец доски (owner_id в ответе BoardDetail).

План проекта

Мои задачи

Доски

Задачи, сроки и базовый планКак исполнитель сдает результатКомандная очередь работы

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

Функциональная карта