Bitrix24 REST v3 API
The REST v3 API from Bitrix24 — 25 operation(s) for rest v3.
OpenAPI Specification
openapi: 3.0.3
info:
title: Bitrix24 REST BIconnector REST v3 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: REST v3
paths:
/main.eventlog.field.get:
post:
summary: Get Event Log Field main.eventlog.field.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 `main.eventlog.field.get` returns the description of the event log field by name.
operationId: main_eventlog_field_get
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/main/main-eventlog-field-get.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: '| The name of the field whose description is to be retrieved ||'
select:
type: array
items: {}
description: '| A list of description fields to return in the response.'
required:
- name
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
description: '| The name of the field whose description is to be retrieved ||'
select:
type: array
items: {}
description: '| A list of description fields to return in the response.'
required:
- name
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:
- main
/main.eventlog.field.list:
post:
summary: Get the List of Event Log Fields main.eventlog.field.list
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 `main.eventlog.field.list` returns a list of available fields for event log entries.
operationId: main_eventlog_field_list
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/main/main-eventlog-field-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
select:
type: array
items: {}
description: '| List of description fields to return in the response.'
application/x-www-form-urlencoded:
schema:
type: object
properties:
select:
type: array
items: {}
description: '| List of description fields to return in the response.'
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:
- main
/main.eventlog.get:
post:
summary: Get Event Log Entry main.eventlog.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 `main.eventlog.get` returns an event log entry by its identifier.
operationId: main_eventlog_get
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/main/main-eventlog-get.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Identifier of the log entry ||'
select:
type: array
items: {}
description: '| List of fields to return in the response.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Identifier of the log entry ||'
select:
type: array
items: {}
description: '| List of fields to return in the response.'
required:
- id
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:
- main
/main.eventlog.list:
post:
summary: Get the list of event log entries main.eventlog.list
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 `main.eventlog.list` returns a list of event log entries based on specified conditions.
operationId: main_eventlog_list
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/main/main-eventlog-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
select:
type: array
items: {}
description: '| List of fields to return in the response.'
filter:
type: array
items: {}
description: '| Conditions for filtering entries in the format:'
order:
type: object
description: '| Sorting results in the format `{ "field": "value" }`.'
pagination:
type: object
description: '| Pagination parameters:'
application/x-www-form-urlencoded:
schema:
type: object
properties:
select:
type: array
items: {}
description: '| List of fields to return in the response.'
filter:
type: array
items: {}
description: '| Conditions for filtering entries in the format:'
order:
type: object
description: '| Sorting results in the format `{ "field": "value" }`.'
pagination:
type: object
description: '| Pagination parameters:'
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:
- main
/main.eventlog.tail:
post:
summary: Get New Log Entries main.eventlog.tail
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 `main.eventlog.tail` returns new log entries that appeared after the specified `cursor` reference point, considering the filter.
operationId: main_eventlog_tail
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/main/main-eventlog-tail.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
select:
type: array
items: {}
description: '| List of fields to return in the response.'
filter:
type: array
items: {}
description: '| Conditions for filtering records in the format:'
cursor:
type: object
description: '| Reference point for retrieving new records:'
application/x-www-form-urlencoded:
schema:
type: object
properties:
select:
type: array
items: {}
description: '| List of fields to return in the response.'
filter:
type: array
items: {}
description: '| Conditions for filtering records in the format:'
cursor:
type: object
description: '| Reference point for retrieving new records:'
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:
- main
/tasks.task.access.field.get:
post:
summary: Get Task Access Field Permissions tasks.task.access.field.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 `tasks.task.access.field.get` returns the description of the task access field by name.
operationId: tasks_task_access_field_get
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-access-field-get.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: '| The name of the field whose description is to be retrieved ||'
select:
type: array
items: {}
description: '| A list of description fields to return in the response.'
required:
- name
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
description: '| The name of the field whose description is to be retrieved ||'
select:
type: array
items: {}
description: '| A list of description fields to return in the response.'
required:
- name
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:
- tasks
/tasks.task.access.field.list:
post:
summary: Get the List of Access Permission Fields for tasks.task.access.field.list
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 `tasks.task.access.field.list` returns a list of available access permission fields for tasks.
operationId: tasks_task_access_field_list
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-access-field-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
select:
type: array
items: {}
description: '| List of description fields to return in the response.'
application/x-www-form-urlencoded:
schema:
type: object
properties:
select:
type: array
items: {}
description: '| List of description fields to return in the response.'
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:
- tasks
/tasks.task.access.get:
post:
summary: Check Access Permissions tasks.task.access.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 `tasks.task.access.get` checks the available actions a user can perform on a task.
operationId: tasks_task_access_get
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-access-get.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Task identifier.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Task identifier.'
required:
- id
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:
- tasks
/tasks.task.add:
post:
summary: Add Task tasks.task.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 `tasks.task.add` adds a new task.
operationId: tasks_task_add
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-add.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
fields:
type: object
description: '| Task fields. To create a task, fill in the required fields; without them, the creation operation will not be executed.'
title:
type: string
description: '| Task title ||'
creatorId:
type: integer
description: '| Creator''s identifier.'
responsibleId:
type: integer
description: '| Executor''s identifier.'
required:
- fields
- title
- creatorId
- responsibleId
application/x-www-form-urlencoded:
schema:
type: object
properties:
fields:
type: object
description: '| Task fields. To create a task, fill in the required fields; without them, the creation operation will not be executed.'
title:
type: string
description: '| Task title ||'
creatorId:
type: integer
description: '| Creator''s identifier.'
responsibleId:
type: integer
description: '| Executor''s identifier.'
required:
- fields
- title
- creatorId
- responsibleId
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:
- tasks
/tasks.task.chat.message.field.get:
post:
summary: Get Chat Message Field of Task tasks.task.chat.message.field.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 `tasks.task.chat.message.field.get` returns the description of a chat message field for a task by name.
operationId: tasks_task_chat_message_field_get
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-chat-message-field-get.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: '| The name of the field whose description is to be retrieved ||'
select:
type: array
items: {}
description: '| A list of description fields to return in the response.'
required:
- name
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
description: '| The name of the field whose description is to be retrieved ||'
select:
type: array
items: {}
description: '| A list of description fields to return in the response.'
required:
- name
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:
- tasks
/tasks.task.chat.message.field.list:
post:
summary: Get the List of Chat Message Fields for tasks.task.chat.message.field.list
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 `tasks.task.chat.message.field.list` returns a list of available fields for a task chat message.
operationId: tasks_task_chat_message_field_list
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-chat-message-field-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
select:
type: array
items: {}
description: '| List of description fields to return in the response.'
application/x-www-form-urlencoded:
schema:
type: object
properties:
select:
type: array
items: {}
description: '| List of description fields to return in the response.'
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:
- tasks
/tasks.task.chat.message.send:
post:
summary: Send a Message in Task Chat tasks.task.chat.message.send
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 `tasks.task.chat.message.send` sends a new message to the task chat.
operationId: tasks_task_chat_message_send
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-chat-message-send.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
fields:
type: object
description: '| An object with message parameters ||'
taskId:
type: integer
description: '| The identifier of the task to which the message should be sent.'
text:
type: string
description: '| The message text ||'
required:
- fields
- taskId
- text
application/x-www-form-urlencoded:
schema:
type: object
properties:
fields:
type: object
description: '| An object with message parameters ||'
taskId:
type: integer
description: '| The identifier of the task to which the message should be sent.'
text:
type: string
description: '| The message text ||'
required:
- fields
- taskId
- text
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:
- tasks
/tasks.task.delete:
post:
summary: Delete Task tasks.task.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 `tasks.task.delete` removes a task. You can check the permission to delete a task using the [task access check method](./tasks-task-access-get.md).
operationId: tasks_task_delete
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-delete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: '| Task identifier.'
required:
- id
application/x-www-form-urlencoded:
schema:
type: object
properties:
id:
type: integer
description: '| Task identifier.'
required:
- id
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:
- tasks
/tasks.task.field.get:
post:
summary: Get Task Field tasks.task.field.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 `tasks.task.field.get` returns the description of a task field by name.
operationId: tasks_task_field_get
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-field-get.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: '| The name of the field whose description is to be retrieved ||'
select:
type: array
items: {}
description: '| A list of description fields to return in the response.'
required:
- name
application/x-www-form-urlencoded:
schema:
type: object
properties:
name:
type: string
description: '| The name of the field whose description is to be retrieved ||'
select:
type: array
items: {}
description: '| A list of description fields to return in the response.'
required:
- name
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:
- tasks
/tasks.task.field.list:
post:
summary: Get the List of Task Fields tasks.task.field.list
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 `tasks.task.field.list` returns a list of available task fields.
operationId: tasks_task_field_list
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-field-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
select:
type: array
items: {}
description: '| List of field descriptions to be returned in the response.'
application/x-www-form-urlencoded:
schema:
type: object
properties:
select:
type: array
items: {}
description: '| List of field descriptions to be returned in the response.'
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:
- tasks
/tasks.task.file.attach:
post:
summary: Attach Files to a Task tasks.task.file.attach
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 `tasks.task.file.attach` adds files from Drive to a task. The user must have read access to the file or higher.
operationId: tasks_task_file_attach
tags:
- REST v3
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-file-attach.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
taskId:
type: integer
description: '| The identif
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitrix24/refs/heads/main/openapi/bitrix24-rest-v3-api-openapi.yml