#Tasks

Entity: task | Scope: tasks | Base path: /v1/tasks

Legacy entity (UPPER_CASE field names) — field names are automatically converted to camelCase.

#Operations

Method Path Description Bitrix24 Method
GET /v1/tasks List all (with filter, sort, pagination) tasks.task.list
GET /v1/tasks/:id Get by ID tasks.task.get
POST /v1/tasks Create new tasks.task.add
PATCH /v1/tasks/:id Update by ID tasks.task.update
DELETE /v1/tasks/:id Delete by ID tasks.task.delete
GET /v1/tasks/fields Get available fields tasks.task.getFields

#Fields

API Name Bitrix24 Name Type Readonly Description
id ID number yes Идентификатор записи
title TITLE string Название задачи
description DESCRIPTION string Описание задачи (HTML)
responsibleId RESPONSIBLE_ID number ID ответственного
creatorId CREATED_BY number yes
status STATUS number Статус задачи (числовой) (2 = ожидает, 3 = в работе, 4 = ожидает контроля, 5 = завершена, 6 = отложена)
priority PRIORITY number Приоритет задачи (LOW, NORMAL, HIGH)
groupId GROUP_ID number ID рабочей группы/проекта
parentId PARENT_ID number ID родительской задачи
deadline DEADLINE datetime Крайний срок (ISO 8601)
startDatePlan START_DATE_PLAN datetime Плановая дата начала
endDatePlan END_DATE_PLAN datetime Плановая дата окончания
timeEstimate TIME_ESTIMATE number
tags TAGS string Массив тегов
accomplices ACCOMPLICES array
auditors AUDITORS array
closedDate CLOSED_DATE datetime yes
createdDate CREATED_DATE datetime yes
changedDate CHANGED_DATE datetime yes

#Relations (reference)

Relation Entity Type Foreign Key
responsible user one responsibleId
creator user one creatorId

#Aggregatable Fields

These fields can be used with the aggregation engine for analytics:

  • status
  • priority
  • responsibleId
  • groupId

#Examples

#List

Terminal
curl -X GET '/v1/tasks?limit=10' \
  -H 'X-Api-Key: YOUR_KEY'

#Get by ID

Terminal
curl -X GET '/v1/tasks/123' \
  -H 'X-Api-Key: YOUR_KEY'

#Create

Terminal
curl -X POST '/v1/tasks' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title":"value","description":"value","responsibleId":1}'

#Update

Terminal
curl -X PATCH '/v1/tasks/123' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title":"updated"}'

#Delete

Terminal
curl -X DELETE '/v1/tasks/123' \
  -H 'X-Api-Key: YOUR_KEY'

#Batch

Terminal
curl -X POST '/v1/batch' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"calls":[{"entity":"tasks","action":"list","params":{"limit":5}}]}'