Configuring and Using the REST API
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
This section provides answers to practical questions that arise during integration development:
- how to securely access the REST API,
- how to configure different types of applications,
- how to optimize load.
To make your first request, study the First Steps section.
To find a specific Bitrix24 REST API method, use the Method Reference.
Configuring REST Calls
Review materials explaining how to form requests, encode data, and retrieve sequential selections.
- What a basic request looks like and how response formats differ — How a Request Is Executed.
- How to perform sequential method calls and pass results between requests — How to Execute a Batch Request.
- What to do if parameters contain special characters — Data Encoding.
- How to correctly retrieve lists and work with the
startparameter — Features of List Methods. - Why a request stopped working after a domain change and how to handle redirects — REST Call Specifics When a Bitrix24 Address Changes.
Performing Authorization
Choose an authorization method — from simple webhooks to the full OAuth 2.0 cycle, and configure automatic token renewal and error handling.
- The difference between webhooks and the OAuth protocol — Authorization in REST.
- How OAuth authorization works step by step — Full OAuth 2.0 Authorization Protocol.
- How to perform authorization directly within the application interface or via an installation event — Simplified Token Retrieval.
- How to avoid losing access overnight and when to refresh
refresh_token— Automatic OAuth 2.0 Token Renewal. - How to troubleshoot
invalid_client,insufficient_scope, and other errors — Error Codes.
Installing and Configuring an Application
Choose the appropriate scenario and follow the instructions for local, mass-market, or configuration solutions.
- Choosing the right application type — Application Installation Options in Bitrix24.
- How to add a local application — Overview of Local Application Installation.
- How to create and install a mass-market solution — Overview of Mass-Market Application Installation.
- When to call
installFinishand what to check before launching — Completing Application Installation. - How to publish ready-made sites, industry CRMs, and Smart scripts — Installing Site Templates, Installing Industry CRMs, Installing Solutions with Smart Scripts.
- Which data is deleted when an application is removed and how to handle the deletion event — Deleting Applications.
Configure Application Operation in Cloud and Self-Hosted
Compare the requirements for the cloud and self-hosted versions, configure the network, and extend the API if necessary.
- What to consider for application operation in the self-hosted version — REST API Features in the Self-Hosted Version.
- Why a method may be unavailable — Module Versioning in Self-Hosted Bitrix24.
- Which domains to open and where to get the IP list for event queues — Required Network Accesses.
- What to do if the corporate network is isolated and the authorization server needs to be replaced — Application Authorization in an Isolated Bitrix24 Self-Hosted Environment.
- How to add custom methods and new scopes — Adding Custom Methods to the Bitrix24 Self-Hosted REST API.
- Which security requirements to consider during development — Security Recommendations for REST API Applications.
Implement an Interactive Interface and Instant Events
Use Push & Pull to react instantly to user actions in the interface.
- Which interactivity options are available — Interactive Applications.
- How to create and configure your own Push & Pull client — Custom Push & Pull Client.
- Which methods to use to retrieve connection parameters and send push events — Push & Pull.
Optimize Performance Under Load
Apply recommendations for query optimization, queue management, and limit control.
- How to reduce the number of requests and speed up responses — General Recommendations.
- How to export thousands of items and avoid counting the total amount — How to Retrieve Large Volumes of Data.
- How to build an incoming queue and protect handlers from spikes — Incoming Event Queue.
- Which restrictions apply to the REST API — Limits.