REST API Reference: Bitrix24 tools and methods

Using the REST API, an application works with Bitrix24 tools. For example, it can create a deal in the CRM, retrieve a task, upload a file to Drive, process a data change event, or embed a widget into a card.

Quick links: all reference sections

How to use the referenceHow to use the reference

Start with what is already known: what data the application should retrieve or change, which method needs to be called, or which permissions to grant.

For example, to work with customers, open CRM. It contains methods for leads, deals, contacts, companies, and other CRM objects. For tasks, the Tasks section is suitable; for files, use Drive; for online store orders, use Online store.

If you know the name of a method, look for it in the relevant section or via search. From the names of many methods, you can understand which object the method works with and what action it performs: crm.deal.add creates a deal, tasks.task.get retrieves a task, disk.file.get retrieves a file.

If the name of the required method is unknown, open the reference sections overview and choose the appropriate section. The section page contains a list of methods and links to related materials.

Check the application permissions in the Method scopes section. A scope determines which groups of methods an application can access via the REST API. It is specified when configuring application permissions.

A scope does not grant access to all data by itself. The application will only see the data that the user executing the request has access to.

What information is on the method pagesWhat information is on the method pages

Method pages help prepare individual requests. They specify what action the method performs, which parameters to pass, and what response the server will return.

They do not describe a complete workflow. If you need to solve a task entirely, start with the tool's overview page or check the Tutorials.

Reference sections overviewReference sections overview

REST API basicsREST API basics

Section	Description
Data types and parameter formats	Basic types, date formats, files, and complex parameters
Method scopes	Application permissions to method groups
Common methods and events	System methods, application settings, users, and common events
Events	Registration, deletion, and processing of REST API events
REST 3.0	Methods and rules of the new REST API version
Deprecated methods	Methods to support existing integrations

Sales and customersSales and customers

Section	Description
CRM	Leads, deals, contacts, companies, SPAs, and related objects
Online Store	Orders, cart, payments, shipments, cash registers, and store events
Product Catalog	Products, offers, prices, warehouses, and warehouse documents
Payment Systems	Payment processors and payment settings
Document Generator	Documents, templates, numbering, and roles
Signature	Electronic document signing

Automation and company operationsAutomation and company operations

Section	Description
Business Processes and Robots	Templates, tasks, robots, and business process actions
Tasks	Tasks, checklists, comments, templates, stages, and flows
Workgroups and Projects	Workgroups, projects, participants, and scrum
Calendar	Calendars, events, and resources
Company Structure	Company departments
Time Tracking	Working time, schedules, and time control
Users	Users and user fields

CommunicationsCommunications

Section	Description
Chats	Chats, messages, files, users, and notifications
Bot Platform	Chatbots, commands, messages, and bot events
Open Channels	Open Channels, sessions, operators, chats, and connectors
Telephony	Telephony, calls, and Voximplant lines
Messaging providers, SMS providers	Messaging providers and SMS providers
News Feed	News, comments, and feed events
Email Services	Email services

Data, files, and contentData, files, and content

Section	Description
Drive	Files, folders, data store, versions, and permissions
How to work with files	File transfer formats in REST API
Data store	Data store and application data items
Universal Lists	Lists, sections, fields, and items
Sites and stores	Sites, pages, blocks, templates, and permissions
Online booking	Resources, bookings, waiting lists, clients, and events
Surveys, polls	Surveys and polls
User agreements	User agreements

Platform capabilitiesPlatform capabilities

Section	Description
Widgets	Application interface embedding points in Bitrix24
BIconnector	Sources, connectors, and BI analytics datasets
BitrixGPT	Bitrix24 AI capabilities
Vibe	Vibe widgets and interactive items