Bitrix24 Tasks API
The Tasks API from Bitrix24 — 114 operation(s) for tasks.
OpenAPI Specification
openapi: 3.0.3
info:
title: Bitrix24 REST BIconnector Tasks API
version: 1.0.0
description: 'Bitrix24 REST API provides access to CRM, tasks, drive, chats, telephony, e-commerce, automation, and other modules. Documentation: https://apidocs.bitrix24.com'
contact:
name: Bitrix24 Developer Support
url: https://apidocs.bitrix24.com/support.html
license:
name: MIT
url: https://github.com/bitrix-tools/b24-rest-docs/blob/main/LICENSE
x-logo:
url: https://apidocs.bitrix24.com/_images/bitrix24logo.svg
servers:
- url: https://{portal}.bitrix24.com/rest
description: Your Bitrix24 portal (cloud)
variables:
portal:
default: your-portal
description: Subdomain of your Bitrix24 portal
- url: https://{host}/rest
description: On-Premise Bitrix24 installation
variables:
host:
default: your-bitrix24.example.com
description: Host of your on-premise installation
security:
- AccessToken: []
tags:
- name: Tasks
paths:
/task.checklistitem.add:
post:
summary: Add checklist item task.checklistitem.add
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.add` adds a new checklist item to a task. You can check permissions for adding an item using the method [task.checklistitem.isactionallowed](./task-checklist-item-is-action-allowed.md).
operationId: task_checklistitem_add
tags:
- Tasks
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-add.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
FIELDS:
type: object
description: '| Object with checklist item fields ||'
TITLE:
type: string
description: '| Text of the checklist item.'
SORT_INDEX:
type: integer
description: '| Sort index. The lower the value, the higher the item in the list or sublist ||'
IS_COMPLETE:
type: boolean
description: '| Status of the item. Possible values:'
IS_IMPORTANT:
type: boolean
description: '| Mark indicating that the item is important. Possible values:'
MEMBERS:
type: object
description: '| Object describing the participants of the checklist item. Key — user identifier, value — object with participant type parameter `TYPE`. Possible participant type values:'
PARENT_ID:
type: integer
description: '| Identifier of the parent item. Use for nested checklists.'
required:
- TASKID
- FIELDS
- TITLE
application/x-www-form-urlencoded:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
FIELDS:
type: object
description: '| Object with checklist item fields ||'
TITLE:
type: string
description: '| Text of the checklist item.'
SORT_INDEX:
type: integer
description: '| Sort index. The lower the value, the higher the item in the list or sublist ||'
IS_COMPLETE:
type: boolean
description: '| Status of the item. Possible values:'
IS_IMPORTANT:
type: boolean
description: '| Mark indicating that the item is important. Possible values:'
MEMBERS:
type: object
description: '| Object describing the participants of the checklist item. Key — user identifier, value — object with participant type parameter `TYPE`. Possible participant type values:'
PARENT_ID:
type: integer
description: '| Identifier of the parent item. Use for nested checklists.'
required:
- TASKID
- FIELDS
- TITLE
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- task
/task.checklistitem.complete:
post:
summary: Mark checklist item as completed task.checklistitem.complete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.complete` marks a checklist item as completed.
operationId: task_checklistitem_complete
tags:
- Tasks
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-complete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
ITEMID:
type: integer
description: '| Checklist item identifier.'
required:
- TASKID
- ITEMID
application/x-www-form-urlencoded:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
ITEMID:
type: integer
description: '| Checklist item identifier.'
required:
- TASKID
- ITEMID
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- task
/task.checklistitem.delete:
post:
summary: Delete checklist item task.checklistitem.delete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.delete` removes a checklist item from a task. You can check permissions for deleting an item using the method [task.checklistitem.isactionallowed](./task-checklist-item-is-action-allowed.md).
operationId: task_checklistitem_delete
tags:
- Tasks
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-delete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
ITEMID:
type: integer
description: '| Checklist item identifier.'
required:
- TASKID
- ITEMID
application/x-www-form-urlencoded:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
ITEMID:
type: integer
description: '| Checklist item identifier.'
required:
- TASKID
- ITEMID
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- task
/task.checklistitem.get:
post:
summary: Get checklist item task.checklistitem.get
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.get` retrieves the description of a checklist item by its identifier.
operationId: task_checklistitem_get
tags:
- Tasks
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-get.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
ITEMID:
type: integer
description: '| Checklist item identifier.'
required:
- TASKID
- ITEMID
application/x-www-form-urlencoded:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
ITEMID:
type: integer
description: '| Checklist item identifier.'
required:
- TASKID
- ITEMID
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- task
/task.checklistitem.getlist:
post:
summary: Get the list of checklist items task.checklistitem.getlist
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.getlist` retrieves a list of checklist items in a task.
operationId: task_checklistitem_getlist
tags:
- Tasks
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-get-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
ORDER:
type: object
description: '| An object for sorting the result in the form `{"field": "sort value", ... }`.'
required:
- TASKID
application/x-www-form-urlencoded:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
ORDER:
type: object
description: '| An object for sorting the result in the form `{"field": "sort value", ... }`.'
required:
- TASKID
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- task
/task.checklistitem.getmanifest:
post:
summary: Get a list of methods and their description task.checklistitem.getmanifest
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.getmanifest` retrieves information about the methods for working with task checklist items `task.checklistitem.*`. It is recommended to use the result only as a reference, as the structure of the method's response can be changed by the developer at any time.
operationId: task_checklistitem_getmanifest
tags:
- Tasks
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-get-manifest.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
application/x-www-form-urlencoded:
schema:
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- task
/task.checklistitem.isactionallowed:
post:
summary: Check Action Permission for task.checklistitem.isactionallowed
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.isactionallowed` checks whether an action is permitted for a checklist item in a task.
operationId: task_checklistitem_isactionallowed
tags:
- Tasks
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-is-action-allowed.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
ITEMID:
type: integer
description: '| Checklist item identifier.'
ACTIONID:
type: integer
description: '| Identifier of the action being checked:'
required:
- TASKID
- ITEMID
- ACTIONID
application/x-www-form-urlencoded:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
ITEMID:
type: integer
description: '| Checklist item identifier.'
ACTIONID:
type: integer
description: '| Identifier of the action being checked:'
required:
- TASKID
- ITEMID
- ACTIONID
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- task
/task.checklistitem.moveafteritem:
post:
summary: Move Checklist Item task.checklistitem.moveafteritem
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.moveafteritem` moves the checklist item `itemId` to a position after the element `afterItemId`. Both elements must belong to the same task `taskId`. The elements can be in different sublists, but after the move, `itemId` will have the same `PARENT_ID` as `afterItemId`. You can check permissions to modify the item using the method [task.checklistitem.isactionallowed](./task-checklist-item-is-action-allowed.md).
operationId: task_checklistitem_moveafteritem
tags:
- Tasks
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-move-after-item.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Identifier of the task.'
ITEMID:
type: integer
description: '| Identifier of the checklist item being moved.'
AFTERITEMID:
type: integer
description: '| Identifier of the checklist item after which the moving item should be placed.'
required:
- TASKID
- ITEMID
- AFTERITEMID
application/x-www-form-urlencoded:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Identifier of the task.'
ITEMID:
type: integer
description: '| Identifier of the checklist item being moved.'
AFTERITEMID:
type: integer
description: '| Identifier of the checklist item after which the moving item should be placed.'
required:
- TASKID
- ITEMID
- AFTERITEMID
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- task
/task.checklistitem.renew:
post:
summary: Mark a checklist item as incomplete task.checklistitem.renew
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.renew` marks a completed checklist item as active.
operationId: task_checklistitem_renew
tags:
- Tasks
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-renew.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
ITEMID:
type: integer
description: '| Checklist item identifier.'
required:
- TASKID
- ITEMID
application/x-www-form-urlencoded:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
ITEMID:
type: integer
description: '| Checklist item identifier.'
required:
- TASKID
- ITEMID
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- task
/task.checklistitem.update:
post:
summary: Update checklist item task.checklistitem.update
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.checklistitem.update` modifies an existing checklist item. You can check permissions to modify the item using the method [task.checklistitem.isactionallowed](./task-checklist-item-is-action-allowed.md).
operationId: task_checklistitem_update
tags:
- Tasks
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/tasks/checklist-item/task-checklist-item-update.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
ITEMID:
type: integer
description: '| Checklist item identifier.'
FIELDS:
type: object
description: '| Object with checklist item fields ||'
TITLE:
type: string
description: '| Text of the checklist item.'
SORT_INDEX:
type: integer
description: '| Sort index. The lower the value, the higher the item in the list or sublist ||'
IS_COMPLETE:
type: boolean
description: '| Status of the item. Possible values:'
IS_IMPORTANT:
type: boolean
description: '| Mark indicating that the item is important. Possible values:'
MEMBERS:
type: object
description: '| Object describing the participants of the checklist item. Key — user identifier, value — object with the participant type parameter `TYPE`. Possible participant type values:'
PARENT_ID:
type: integer
description: '| Identifier of the parent item. Use for nested checklists.'
required:
- TASKID
- ITEMID
- FIELDS
application/x-www-form-urlencoded:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
ITEMID:
type: integer
description: '| Checklist item identifier.'
FIELDS:
type: object
description: '| Object with checklist item fields ||'
TITLE:
type: string
description: '| Text of the checklist item.'
SORT_INDEX:
type: integer
description: '| Sort index. The lower the value, the higher the item in the list or sublist ||'
IS_COMPLETE:
type: boolean
description: '| Status of the item. Possible values:'
IS_IMPORTANT:
type: boolean
description: '| Mark indicating that the item is important. Possible values:'
MEMBERS:
type: object
description: '| Object describing the participants of the checklist item. Key — user identifier, value — object with the participant type parameter `TYPE`. Possible participant type values:'
PARENT_ID:
type: integer
description: '| Identifier of the parent item. Use for nested checklists.'
required:
- TASKID
- ITEMID
- FIELDS
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- task
/task.comment.add:
post:
summary: Add Comment to Task task.comment.add
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [tasks.task.chat.message.send](../../rest-v3/tasks/tasks-task-chat-message-send.md). This method adds comments to a task.
operationId: task_comment_add
tags:
- Tasks
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/tasks/deprecated/task-comment-add.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
Name:
type: string
description: '| Description ||'
TASKID:
type: string
description: '| Task identifier ||'
COMMENTTEXT:
type: string
description: '| Comment ||'
application/x-www-form-urlencoded:
schema:
type: object
properties:
Name:
type: string
description: '| Description ||'
TASKID:
type: string
description: '| Task identifier ||'
COMMENTTEXT:
type: string
description: '| Comment ||'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- task
/task.commentitem.add:
post:
summary: Add Comment task.commentitem.add
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.commentitem.add` adds a new comment to a task. The development of this method has been halted since version `tasks 25.700.0`. Please use [tasks.task.chat.message.send](../../rest-v3/tasks/tasks-task-chat-message-send.md).
operationId: task_commentitem_add
tags:
- Tasks
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/tasks/comment-item/task-comment-item-add.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
FIELDS:
type: object
description: '| Object with comment fields ||'
POST_MESSAGE:
type: string
description: '| Message text ||'
AUTHOR_ID:
type: integer
description: '| Identifier of the user on behalf of whom the comment should be created.'
POST_DATE:
type: string
description: '| Message date ||'
UF_FORUM_MESSAGE_DOC:
type: array
items: {}
description: '| Array of file identifiers from Drive. Prefix each identifier with `n`, for example, `[''n123'', ''n456'', ... ]`.'
required:
- TASKID
- FIELDS
- POST_MESSAGE
application/x-www-form-urlencoded:
schema:
type: object
properties:
TASKID:
type: integer
description: '| Task identifier.'
FIELDS:
type: object
description: '| Object with comment fields ||'
POST_MESSAGE:
type: string
description: '| Message text ||'
AUTHOR_ID:
type: integer
description: '| Identifier of the user on behalf of whom the comment should be created.'
POST_DATE:
type: string
description: '| Message date ||'
UF_FORUM_MESSAGE_DOC:
type: array
items: {}
description: '| Array of file identifiers from Drive. Prefix each identifier with `n`, for example, `[''n123'', ''n456'', ... ]`.'
required:
- TASKID
- FIELDS
- POST_MESSAGE
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- task
/task.commentitem.delete:
post:
summary: Delete Comment task.commentitem.delete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `task.commentitem.delete` removes a comment. Development of this method has been halted since version `tasks 25.700.0`. The method `task.commentitem.delete` does not work in the [new task card](../tasks-new.md); please use the method [im.message.delete](../../chats/messages/im-message-delete.md) for managing task chat.
operationId: task_commentitem_delete
tags:
- Tasks
externalDocs:
url: htt
# --- truncated at 32 KB (270 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitrix24/refs/heads/main/openapi/bitrix24-tasks-api-openapi.yml