Setting Up and Using the REST API

This section contains answers to practical questions that arise during integration development:

To make your first request, check out the Getting Started section.

To find a specific REST API method, use the Method Reference.

Configure REST Calls

Review materials that explain how to form requests, encode data, and handle sequential queries.

What a basic request looks like and how response formats differ — How to Make a Request.
How to perform sequential method calls and pass results between requests — How to Execute a Batch of Requests.
What to do if parameters contain special characters — Data Encoding.
How to properly retrieve lists and work with the start parameter — Features of List Methods.
Why a request stopped working after changing the domain and how to handle redirects — Features of REST Calls When Changing the Bitrix24 Address.

Choose an authorization method — from simple webhooks to a full OAuth 2.0 cycle, set up automatic token renewal and error handling.

How webhooks and the OAuth protocol differ — Authorization in REST.
How OAuth authorization works step by step — Complete OAuth 2.0 Authorization Protocol.
How to perform authorization directly in the application interface or through the installation event — Simplified Token Acquisition.
How to avoid losing access overnight and when to refresh the refresh_token — Automatic Renewal of OAuth 2.0 Tokens.
How to deal with errors like invalid_client, insufficient_scope, and others — Error Codes.

Choose the appropriate scenario and follow the instructions for local, mass-market, or configuration solutions.

Select the suitable application option — Application Installation Options in Bitrix24.
How to add a local application — Overview of Installing Local Applications.
How to create and install a mass-market solution — Overview of Installing Mass-Market Applications.
When to call installFinish and what to check before launching — Completing Application Installation.
How to publish ready-made sites, industry CRMs, and smart scenarios — Installing Site Templates, Installing Industry CRMs, Installing Solutions with Smart Scenarios.
What data is deleted when an application is removed and how to handle the deletion event — Uninstalling Applications.

Compare the requirements of the cloud and on-premise versions, configure the network, and expand the API if necessary.

What is important to consider for the application to work in the on-premise version — Differences in Using the REST API.
Why a method may be unavailable — Versioning of Modules in On-Premise Bitrix24.
Which domains to open and where to get the list of IPs for event queues — Required Network Access.
What to do if the corporate network is isolated and you need to replace the authorization server — Application Authorization in Isolated On-Premise Bitrix24.
How to add your own methods and new scopes — Adding Custom Methods to the On-Premise Bitrix24 REST API.
What security requirements to consider during development — Security Recommendations for Applications Using the REST API.

Use Push & Pull to instantly respond to user actions in the interface.

What interactive options are available — Interactive Applications.
How to create and configure your own Push & Pull client — Custom Push & Pull Client.
Which methods to use to get connection parameters and send push events — Push & Pull.

Apply recommendations for optimizing requests, working with queues, and controlling limits.

How to reduce the number of requests and speed up responses — General Recommendations.
How to export thousands of items and avoid counting the total — Retrieve Large Volumes of Data.
How to build an incoming queue and protect handlers from spikes — Incoming Event Queue.
What limitations apply to the REST API — Limits.