Getting Started

The documentation for the Bitrix24 REST API describes API methods, request examples, and integration scenarios for application and external service development.

Below is the recommended sequence for studying the documentation, which will help:

• understand the structure of the documentation,
• master the basic capabilities of the API,
• move on to more complex scenarios.

Accessing the REST APIAccessing the REST API

The section How to Access the REST API describes how to activate the trial period and gain access to all methods and capabilities of the Bitrix24 REST API. It also includes information about NFR keys for partner developments.

Setting Up and Using the REST APISetting Up and Using the REST API

The section Setting Up and Using the REST API is dedicated to parameters that affect integration operations:

• authorization domains,
• access permissions,
• method call specifics,
• environment configuration,
• request limits.

This section also contains the article Configuring Access: Cloud and On-Premise Versions, which describes how to set up network access for incoming and outgoing requests and how to add IP addresses to the allowed list.

First API RequestFirst API Request

The section How to Make Your First API Request explains how to create an incoming webhook and make your first REST API method call. This allows you to verify the API's functionality and the correctness of the settings.

Request ExamplesRequest Examples

The section How to Use Examples in Documentation describes how to work with request examples, which programming languages are used, and how to connect to libraries. It also shows how to adapt examples to your task and make real requests to the API.

SDK for Bitrix24 DevelopmentSDK for Bitrix24 Development

The section SDK for Bitrix24 Development describes ready-made libraries for development and provides information on connecting the MCP service for AI assistants in the development environment.

Local IntegrationsLocal Integrations

The section Overview of Tools for Local Integrations is dedicated to tools for creating integrations that work within Bitrix24 and do not require publication in the Marketplace. This section includes examples of working with local webhooks and applications for task automation and data exchange.

Ready-Made ScenariosReady-Made Scenarios

The section Tutorials: Ready-made Use Cases for REST API contains step-by-step guides and ready-made scenarios for using the Bitrix24 REST API. For example, how to create and configure a cash register handler or how to retrieve a client's address from the CRM. These examples can be used as a basis for your own solutions.

Mass-Market ApplicationsMass-Market Applications

The section Overview of Mass-Market Applications describes the principles of working with mass-market applications from the Bitrix24 Marketplace, as well as opportunities for monetization and promotion.

API ReferenceAPI Reference

The section API Reference contains descriptions of methods and capabilities of the Bitrix24 REST API. This material helps navigate the API and select methods for specific functionalities.