How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bitrix24 REST v3 API

The REST v3 API from Bitrix24 — 25 operation(s) for rest v3.

Bitrix24 REST v3 API is one of 36 APIs that Bitrix24 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include REST v3. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 25 operations across 25 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://{portal}.bitrix24.com/rest, https://{host}/rest.

25 operations 25 paths 3 schemas 25 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://{installation}.bitrix24.com/rest/
Authentication
API Key, OAuth 2.0
License
Resource Areas
1

Authentication & Security 2

Bitrix24 REST v3 API declares 2 security schemes for authenticating requests. An API key is passed in the query as auth (AccessToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 45 scopes. By default, every request must be authenticated.

  • AccessToken — OAuth 2.0 accesstoken or incoming webhook token
  • OAuth2 — OAuth 2.0 authorization

Paths & Operations 25

Across 25 paths, the API surfaces 25 operations — 25 POST. Each is listed below with its method, path, parameters, and response codes.

REST v3 25
POST
/main.eventlog.field.get
Get Event Log Field main.eventlog.field.get
main_eventlog_field_get body → 2004XX
POST
/main.eventlog.field.list
Get the List of Event Log Fields main.eventlog.field.list
main_eventlog_field_list body → 2004XX
POST
/main.eventlog.get
Get Event Log Entry main.eventlog.get
main_eventlog_get body → 2004XX
POST
/main.eventlog.list
Get the list of event log entries main.eventlog.list
main_eventlog_list body → 2004XX
POST
/main.eventlog.tail
Get New Log Entries main.eventlog.tail
main_eventlog_tail body → 2004XX
POST
/tasks.task.access.field.get
Get Task Access Field Permissions tasks.task.access.field.get
tasks_task_access_field_get body → 2004XX
POST
/tasks.task.access.field.list
Get the List of Access Permission Fields for tasks.task.access.field.list
tasks_task_access_field_list body → 2004XX
POST
/tasks.task.access.get
Check Access Permissions tasks.task.access.get
tasks_task_access_get body → 2004XX
POST
/tasks.task.add
Add Task tasks.task.add
tasks_task_add body → 2004XX
POST
/tasks.task.chat.message.field.get
Get Chat Message Field of Task tasks.task.chat.message.field.get
tasks_task_chat_message_field_get body → 2004XX
POST
/tasks.task.chat.message.field.list
Get the List of Chat Message Fields for tasks.task.chat.message.field.list
tasks_task_chat_message_field_list body → 2004XX
POST
/tasks.task.chat.message.send
Send a Message in Task Chat tasks.task.chat.message.send
tasks_task_chat_message_send body → 2004XX
POST
/tasks.task.delete
Delete Task tasks.task.delete
tasks_task_delete body → 2004XX
POST
/tasks.task.field.get
Get Task Field tasks.task.field.get
tasks_task_field_get body → 2004XX
POST
/tasks.task.field.list
Get the List of Task Fields tasks.task.field.list
tasks_task_field_list body → 2004XX
POST
/tasks.task.file.attach
Attach Files to a Task tasks.task.file.attach
tasks_task_file_attach body → 2004XX
POST
/tasks.task.file.field.get
Get Task File Field Description: tasks.task.file.field.get
tasks_task_file_field_get body → 2004XX
POST
/tasks.task.file.field.list
Get the List of Task File Fields: tasks.task.file.field.list
tasks_task_file_field_list body → 2004XX
POST
/tasks.task.get
Get Task tasks.task.get
tasks_task_get body → 2004XX
POST
/tasks.task.result.add
Add Result to Task tasks.task.result.add
tasks_task_result_add body → 2004XX
POST
/tasks.task.result.addfromchatmessage
Add Result from Task Chat Message tasks.task.result.addfromchatmessage
tasks_task_result_addfromchatmessage body → 2004XX
POST
/tasks.task.result.delete
Delete Task Result tasks.task.result.delete
tasks_task_result_delete body → 2004XX
POST
/tasks.task.result.list
Get the list of task results tasks.task.result.list
tasks_task_result_list body → 2004XX
POST
/tasks.task.result.update
Update Task Result tasks.task.result.update
tasks_task_result_update body → 2004XX
POST
/tasks.task.update
Update Task tasks.task.update
tasks_task_update body → 2004XX

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are BitrixTime (8 properties), BitrixResponse (4 properties), BitrixError (2 properties). Each schema is shown below with its type and property counts.

BitrixError
object
Bitrix24 REST API error response
2 properties 2 required
BitrixTime
object
Request execution time information
8 properties
BitrixResponse
object
Standard Bitrix24 REST API response
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitrix24-rest-v3-api-openapi.yml Raw ↑

Other APIs Bitrix24 publishes across the network.

Bitrix24 REST API
Bitrix24 BIconnector API
Bitrix24 Business Processes API
Bitrix24 Calendar API
Bitrix24 Chatbots API
Bitrix24 Chats API
Bitrix24 Company Structure API
Bitrix24 CoPilot / AI API
Bitrix24 CRM API
Bitrix24 Data Storage API
Bitrix24 Deprecated Methods API
Bitrix24 Document Generator API
Where this information came from

This is an independent, third-party profile of Bitrix24 REST v3 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.