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 identifier of the task to which files need to be attached.'
                fileIds:
                  type: string
                  description: '| An array of file identifiers from Drive.'
              required:
              - taskId
              - fileIds
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                taskId:
                  type: integer
                  description: '| The identifier of the task to which files need to be attached.'
                fileIds:
                  type: string
                  description: '| An array of file identifiers from Drive.'
              required:
              - taskId
              - fileIds
      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.field.get:
    post:
      summary: 'Get Task File Field Description: tasks.task.file.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.file.field.get` returns the description of a task file field by name.
      operationId: tasks_task_file_field_get
      tags:
      - REST v3
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-file-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.file.field.list:
    post:
      summary: 'Get the List of Task File Fields: tasks.task.file.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.file.field.list` returns a list of available fields for task files.
      operationId: tasks_task_file_field_list
      tags:
      - REST v3
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-file-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.get:
    post:
      summary: Get Task tasks.task.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.get` returns information about a task by its identifier. Access to the data depends on permissions: - Administrators can see all tasks,'
      operationId: tasks_task_get
      tags:
      - REST v3
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-get.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: '| Task identifier.'
                select:
                  type: array
                  items: {}
                  description: '| An array of fields that the method will return. If `select` is not specified, a basic set of task fields without related objects is returned.'
              required:
              - id
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: '| Task identifier.'
                select:
                  type: array
                  items: {}
                  description: '| An array of fields that the method will return. If `select` is not specified, a basic set of task fields without related objects is returned.'
              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.result.add:
    post:
      summary: Add Result to Task tasks.task.result.add
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so the assistant can use the official REST documentation. The method `tasks.task.result.add` adds a result to a task.
      operationId: tasks_task_result_add
      tags:
      - REST v3
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/result/tasks-task-result-add.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                fields:
                  type: object
                  description: '| Object with result fields ||'
                taskId:
                  type: integer
                  description: '| Task identifier.'
                text:
                  type: string
                  description: '| Result text ||'
              required:
              - fields
              - taskId
              - text
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                fields:
                  type: object
                  description: '| Object with result fields ||'
                taskId:
                  type: integer
                  description: '| Task identifier.'
                text:
                  type: string
                  description: '| Result 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.result.addfromchatmessage:
    post:
      summary: Add Result from Task Chat Message tasks.task.result.addfromchatmessage
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant uses the official REST documentation. The method `tasks.task.result.addfromchatmessage` creates a task result from a task chat message.
      operationId: tasks_task_result_addfromchatmessage
      tags:
      - REST v3
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/result/tasks-task-result-addfromchatmessage.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                fields:
                  type: object
                  description: '| Object with message fields ||'
                messageId:
                  type: integer
                  description: '| Identifier of the task chat message.'
              required:
              - fields
              - messageId
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                fields:
                  type: object
                  description: '| Object with message fields ||'
                messageId:
                  type: integer
                  description: '| Identifier of the task chat message.'
              required:
              - fields
              - messageId
      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.result.delete:
    post:
      summary: Delete Task Result tasks.task.result.delete
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can use the official REST documentation. The method `tasks.task.result.delete` deletes the task result.
      operationId: tasks_task_result_delete
      tags:
      - REST v3
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/result/tasks-task-result-delete.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: '| Identifier of the result ||'
              required:
              - id
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: '| Identifier of the result ||'
              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.result.list:
    post:
      summary: Get the list of task results tasks.task.result.list
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can use the official REST documentation. The method `tasks.task.result.list` returns a list of task results.
      operationId: tasks_task_result_list
      tags:
      - REST v3
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/result/tasks-task-result-list.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                order:
                  type: object
                  description: '| An object for sorting the list of results in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.'
                filter:
                  type: array
                  items: {}
                  description: '| An array of conditions for filtering the list of results. Be sure to pass the condition for `taskId`.'
                select:
                  type: array
                  items: {}
                  description: '| An array of fields to select.'
                pagination:
                  type: object
                  description: '| An object for managing pagination.'
              required:
              - filter
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                order:
                  type: object
                  description: '| An object for sorting the list of results in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.'
                filter:
                  type: array
                  items: {}
                  description: '| An array of conditions for filtering the list of results. Be sure to pass the condition for `taskId`.'
                select:
                  type: array
                  items: {}
                  description: '| An array of fields to select.'
                pagination:
                  type: object
                  description: '| An object for managing pagination.'
              required:
              - filter
      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.result.update:
    post:
      summary: Update Task Result tasks.task.result.update
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can use the official REST documentation. The method `tasks.task.result.update` updates the text of the task result.
      operationId: tasks_task_result_update
      tags:
      - REST v3
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/result/tasks-task-result-update.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: '| Identifier of the result ||'
                fields:
                  type: object
                  description: '| Object with result fields ||'
                text:
                  type: string
                  description: '| New text of the result ||'
              required:
              - id
              - fields
              - text
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: '| Identifier of the result ||'
                fields:
                  type: object
                  description: '| Object with result fields ||'
                text:
                  type: string
                  description: '| New text of the result ||'
              required:
              - id
              - fields
              - 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.update:
    post:
      summary: Update Task tasks.task.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 `tasks.task.update` updates a task.
      operationId: tasks_task_update
      tags:
      - REST v3
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/rest-v3/tasks/tasks-task-update.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: '| Task identifier.'
                fields:
                  type: object
                  description: '| Values of the task fields to be updated.'
              required:
              - id
              - fields
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: '| Task identifier.'
                fields:
                  type: object
                  description: '| Values of the task fields to be updated.'
              required:
              - id
              - 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:
        - tasks
components:
  schemas:
    BitrixError:
      type: object
      description: Bitrix24 REST API error response
      required:
      - error
      - error_description
      properties:
        error:
          type: string
          description: Error code
          example: ACCESS_DENIED
        error_description:
          type: string
          description: Human-readable error description
          example: Access denied.
    BitrixTime:
      type: object
      description: Request execution time information
      properties:
        start:
          type: number
          format: double
        finish:
          type: number
          format: double
        duration:
          type: number
          format: double
        processing:
          type: number
          format: double
        date_start:
          type: string
          format: date-time
        date_finish:
          type: string
          format: date-time
        operating_reset_at:
          type: integer
        operating:
          type: number
          format: double
    BitrixResponse:
      type: object
      description: Standard Bitrix24 REST API response
      properties:
        result:
          description: Method execution result
        total:
          type: integer
          description: Total number of records (for list methods)
        next:
          type: integer
          description: Next offset for pagination
        time:
          $ref: '#/components/schemas/BitrixTime'
  securitySchemes:
    AccessToken:
      type: apiKey
      in: query
      name: auth
      description: OAuth 2.0 access_token or incoming webhook token
    OAuth2:
      type: oauth2
      description: OAuth 2.0 authorization
      flows:
        authorizationCode:
          authorizationUrl: https://oauth.bitrix.info/oauth/authorize/
          tokenUrl: https://oauth.bitrix.info/oauth/token/
          scopes:
            crm: CRM — leads, deals, contacts, companies, smart processes
            task: Tasks and projects
            disk: Drive — files and folders
            im: Chats and notifications
            imbot: Chatbots
            imopenlines: Open Lines — messenger connectors
            telephony: Telephony
            sale: E-Commerce — orders, shipments
            catalog: Trade Catalog — products, prices
            calendar: Calendar
            bizproc: Business processes and robots
            user: Users
            department: Company structure
            timeman: Time tracking
            landing: Sites and landing pages
            pay_system: Payment systems
            cashbox: Online cash registers
            delivery: Delivery services
            documentgenerator: Document generator
            lists: Universal lists
            entity: Data storage
            log: News feed
            sonet_group: Workgroups and projects
            mailservice: Mail services
            messageservice: Message providers (SMS)
            biconnector: BIconnector — BI analytics
            ai_admin: CoPilot / AI
            sign.b2e: Signature — e-document signing
            vote: Polls and voting
            booking: Online booking
            userconsent: User consent agreements
            userfieldconfig: Custom field settings
            basic: Basic access
            placement: Widget placements
            rpa: Robots process automation
            sonet: Social network
            intranet: Intranet
            socialnetwork: Social network
            workgroups: Workgroups
            salescenter: Sales center
            main: Main module
            imconnector: IM connector
            user.userfield: User custom fields
            user_basic: Basic user access
            userfieldconfig, module scope: Custom field config
externalDocs:
  description: Official Bitrix24 REST API Documentation
  url: https://apidocs.bitrix24.com