Bitrix24

Bitrix24 CRM API

The CRM API from Bitrix24 — 421 operation(s) for crm.

GitHub OpenAPI

Operations 421

Showing the first 250 of 421. The full set is in the contract, and via get_provider_operations.

POST /crm.activity.add Add System Activity crm.activity.add #
POST /crm.activity.badge.add Add Badge crm.activity.badge.add #
POST /crm.activity.badge.delete Delete Badge by Code crm.activity.badge.delete #
POST /crm.activity.badge.get Get Badge Information by Code crm.activity.badge.get #
POST /crm.activity.badge.list Get the list of badges crm.activity.badge.list #
POST /crm.activity.binding.add Add a deal binding to a CRM entity crm.activity.binding.add #
POST /crm.activity.binding.delete Delete the deal's connection with the CRM entity crm.activity.binding.delete #
POST /crm.activity.binding.list Get a list of all bindings for the deal crm.activity.binding.list #
POST /crm.activity.binding.move Update the Deal's Connection with the CRM Entity crm.activity.binding.move #
POST /crm.activity.communication.fields Get Description of Communication crm.activity.communication.fields #
POST /crm.activity.configurable.add Add Configurable CRM Activity crm.activity.configurable.add #
POST /crm.activity.configurable.get Get Configurable Activity by ID crm.activity.configurable.get #
POST /crm.activity.configurable.update Update Configurable Activity crm.activity.configurable.update #
POST /crm.activity.delete Delete activity crm.activity.delete #
POST /crm.activity.fields Get a list of fields for crm.activity.fields #
POST /crm.activity.get Get information about the activity by ID crm.activity.get #
POST /crm.activity.layout.blocks.delete Delete a set of additional content blocks in the CRM activity crm.activity.layout.blocks.delete #
POST /crm.activity.layout.blocks.get Get a Set of Additional Content Blocks in the activity crm.activity.layout.blocks.get #
POST /crm.activity.layout.blocks.set Set a set of additional content blocks in the activity crm.activity.layout.blocks.set #
POST /crm.activity.list Get the list of activities crm.activity.list #
POST /crm.activity.todo.add Add Universal Activity crm.activity.todo.add #
POST /crm.activity.todo.update Update universal deal crm.activity.todo.update #
POST /crm.activity.todo.updateColor Update the color of the universal deal crm.activity.todo.updateColor #
POST /crm.activity.todo.updateDeadline Update Deadline for Universal Activity crm.activity.todo.updateDeadline #
POST /crm.activity.todo.updateDescription Update the description of the universal activity crm.activity.todo.updateDescription #
POST /crm.activity.todo.updateResponsibleUser Update the responsible user for the universal activity crm.activity.todo.updateResponsibleUser #
POST /crm.activity.type.add Add Custom Activity Type crm.activity.type.add #
POST /crm.activity.type.delete Delete Custom Activity Type crm.activity.type.delete #
POST /crm.activity.type.list Get a list of custom activity types crm.activity.type.list #
POST /crm.activity.update Update System CRM Activity crm.activity.update #
POST /crm.address.add Add Address crm.address.add #
POST /crm.address.delete Delete address crm.address.delete #
POST /crm.address.fields Get Description of Address Fields crm.address.fields #
POST /crm.address.list Get a List of Addresses by Filter crm.address.list #
POST /crm.address.update Update Address for crm.address.update #
POST /crm.automatedsolution.add Create Digital Workspace crm.automatedsolution.add #
POST /crm.automatedsolution.delete Delete Digital Workplace crm.automatedsolution.delete #
POST /crm.automatedsolution.fields Get fields of the digital workplace crm.automatedsolution.fields #
POST /crm.automatedsolution.get Get data about the digital workplace by id crm.automatedsolution.get #
POST /crm.automatedsolution.list Get a list of digital workspaces crm.automatedsolution.list #
POST /crm.automatedsolution.update Update Digital Workplace crm.automatedsolution.update #
POST /crm.automation.trigger Activate the crm.automation.trigger #
POST /crm.automation.trigger.add Add Trigger crm.automation.trigger.add #
POST /crm.automation.trigger.execute Execute the Trigger crm.automation.trigger.execute #
POST /crm.automation.trigger.list Get the list of triggers crm.automation.trigger.list #
POST /crm.calllist.add Create a New Call List crm.calllist.add #
POST /crm.calllist.get Get Information About the Call List crm.calllist.get #
POST /crm.calllist.items.get Get the list of call participants crm.calllist.items.get #
POST /crm.calllist.list Get the list of call lists crm.calllist.list #
POST /crm.calllist.statuslist Get the list of call statuses crm.calllist.statuslist #
POST /crm.calllist.update Update Call List Composition crm.calllist.update #
POST /crm.catalog.fields Get Product Catalog Fields crm.catalog.fields #
POST /crm.catalog.get Get Product Catalog by ID crm.catalog.get #
POST /crm.catalog.list Get a List of Product Catalogs crm.catalog.list #
POST /crm.category.add Add a New Sales Funnel crm.category.add #
POST /crm.category.delete Delete Sales Funnel crm.category.delete #
POST /crm.category.fields Get Fields of the Sales Funnel crm.category.fields #
POST /crm.category.get Get the funnel by Id crm.category.get #
POST /crm.category.list Get the list of Sales Funnels crm.category.list #
POST /crm.category.update Update Sales Funnel crm.category.update #
POST /crm.company.add Create a New Company crm.company.add #
POST /crm.company.contact.add Add Contact to the Specified Company crm.company.contact.add #
POST /crm.company.contact.delete Delete Contact from Specified Company crm.company.contact.delete #
POST /crm.company.contact.fields Get Fields for Company-Contact Connection crm.company.contact.fields #
POST /crm.company.contact.items.delete Clear the set of contacts associated with the specified company crm.company.contact.items.delete #
POST /crm.company.contact.items.get Retrieve a Set of Contacts Associated with a Specified Company crm.company.contact.items.get #
POST /crm.company.contact.items.set Set a Set of Contacts Associated with the Specified Company crm.company.contact.items.set #
POST /crm.company.delete Delete Company crm.company.delete #
POST /crm.company.details.configuration.forceCommonScopeForAll Set Common Company Card for All Users crm.company.details.configuration.forceCommonScopeForAll #
POST /crm.company.details.configuration.get Get Parameters for crm.company.details.configuration.get #
POST /crm.company.details.configuration.reset Reset Company Card Settings: crm.company.details.configuration.reset #
POST /crm.company.details.configuration.set Set Parameters for crm.company.details.configuration.set #
POST /crm.company.fields Get Company Fields Description crm.company.fields #
POST /crm.company.get Get Company Information crm.company.get #
POST /crm.company.list Get a List of Companies by Filter crm.company.list #
POST /crm.company.update Update Existing Company crm.company.update #
POST /crm.company.userfield.add Create a Custom Field for Companies crm.company.userfield.add #
POST /crm.company.userfield.delete Delete Custom Field for Companies crm.company.userfield.delete #
POST /crm.company.userfield.get Get Company Custom Field by ID crm.company.userfield.get #
POST /crm.company.userfield.list Get a list of custom fields for companies crm.company.userfield.list #
POST /crm.company.userfield.update Update Company User Field crm.company.userfield.update #
POST /crm.contact.add Create a New Contact crm.contact.add #
POST /crm.contact.company.add Add a Company to the Specified Contact crm.contact.company.add #
POST /crm.contact.company.delete Remove a company from the specified contact crm.contact.company.delete #
POST /crm.contact.company.fields Get Fields for Contact-Company crm.contact.company.fields #
POST /crm.contact.company.items.delete Clear the set of companies associated with the specified contact crm.contact.company.items.delete #
POST /crm.contact.company.items.get Get a set of companies associated with the specified contact crm.contact.company.items.get #
POST /crm.contact.company.items.set Set the set of companies associated with the specified contact crm.contact.company.items.set #
POST /crm.contact.delete Delete Contact crm.contact.delete #
POST /crm.contact.details.configuration.forceCommonScopeForAll Set a Common Contact Card for All Users crm.contact.details.configuration.forceCommonScopeForAll #
POST /crm.contact.details.configuration.get Get Parameters of crm.contact.details.configuration.get #
POST /crm.contact.details.configuration.reset Resetting the Parameters of crm.contact.details.configuration.reset #
POST /crm.contact.details.configuration.set Set Parameters for the Individual Card crm.contact.details.configuration.set #
POST /crm.contact.fields Get Contact Fields crm.contact.fields #
POST /crm.contact.get Get Contact by Id crm.contact.get #
POST /crm.contact.list Get a List of Contacts crm.contact.list #
POST /crm.contact.update Update Contact crm.contact.update #
POST /crm.contact.userfield.add Create a Custom Field for Contacts crm.contact.userfield.add #
POST /crm.contact.userfield.delete Delete Custom Contact Field crm.contact.userfield.delete #
POST /crm.contact.userfield.get Get Custom Contact Field by Id crm.contact.userfield.get #
POST /crm.contact.userfield.list Get a list of custom fields for contacts crm.contact.userfield.list #
POST /crm.contact.userfield.update Update Existing Custom Contact Field crm.contact.userfield.update #
POST /crm.currency.add Add Currency crm.currency.add #
POST /crm.currency.base.get Get the Symbolic Identifier of the Base Currency crm.currency.base.get #
POST /crm.currency.base.set Set Currency as Base crm.currency.base.set #
POST /crm.currency.delete Delete Currency crm.currency.delete #
POST /crm.currency.fields Get Currency Fields crm.currency.fields #
POST /crm.currency.get Get Currency by ID crm.currency.get #
POST /crm.currency.list Get the list of currencies crm.currency.list #
POST /crm.currency.localizations.delete Delete currency localizations crm.currency.localizations.delete #
POST /crm.currency.localizations.fields Get Currency Localization Fields crm.currency.localizations.fields #
POST /crm.currency.localizations.get Get Currency Localizations crm.currency.localizations.get #
POST /crm.currency.localizations.set Set Localizations for Currency crm.currency.localizations.set #
POST /crm.currency.update Update Currency crm.currency.update #
POST /crm.deal.add Create a New Deal crm.deal.add #
POST /crm.deal.contact.add Add Contact to Deal crm.deal.contact.add #
POST /crm.deal.contact.delete Remove Contact from Specified Deal crm.deal.contact.delete #
POST /crm.deal.contact.fields Get Fields for Deal-Contact Connection crm.deal.contact.fields #
POST /crm.deal.contact.items.delete Delete the set of contacts associated with the specified deal crm.deal.contact.items.delete #
POST /crm.deal.contact.items.get Get a set of contacts associated with a deal crm.deal.contact.items.get #
POST /crm.deal.contact.items.set Add Multiple Contacts to a Deal crm.deal.contact.items.set #
POST /crm.deal.delete Delete Deal crm.deal.delete #
POST /crm.deal.details.configuration.forceCommonScopeForAll Set a Common Detail Form for All Users crm.deal.details.configuration.forceCommonScopeForAll #
POST /crm.deal.details.configuration.get Get Parameters of the Deal Card crm.deal.details.configuration.get #
POST /crm.deal.details.configuration.reset Reset Deal Card Settings crm.deal.details.configuration.reset #
POST /crm.deal.details.configuration.set Set Parameters for the Deal Card crm.deal.details.configuration.set #
POST /crm.deal.fields Get Fields of the Deal crm.deal.fields #
POST /crm.deal.get Get Deal by Id crm.deal.get #
POST /crm.deal.list Get a List of Deals crm.deal.list #
POST /crm.deal.productrows.get Get Deal Products crm.deal.productrows.get #
POST /crm.deal.productrows.set Set Products in Deal crm.deal.productrows.set #
POST /crm.deal.recurring.add Create a Template for Recurring Deal crm.deal.recurring.add #
POST /crm.deal.recurring.delete Delete the Recurring Deal Template Setting crm.deal.recurring.delete #
POST /crm.deal.recurring.expose Create a New Deal from the Template crm.deal.recurring.expose #
POST /crm.deal.recurring.fields Get the List of Fields for the Recurring Deal Template crm.deal.recurring.fields #
POST /crm.deal.recurring.get Get Recurring Deal Template Settings by ID crm.deal.recurring.get #
POST /crm.deal.recurring.list Get a List of Recurring Deal Template Settings crm.deal.recurring.list #
POST /crm.deal.recurring.update Update the Recurring Deal Template Settings crm.deal.recurring.update #
POST /crm.deal.update Update Deal crm.deal.update #
POST /crm.deal.userfield.add Create a Custom Field for Deals crm.deal.userfield.add #
POST /crm.deal.userfield.delete Delete Custom Field crm.deal.userfield.delete #
POST /crm.deal.userfield.get Get Custom Deal Field by ID crm.deal.userfield.get #
POST /crm.deal.userfield.list Get a list of custom fields for deals crm.deal.userfield.list #
POST /crm.deal.userfield.update Update Existing Custom Field for Deals crm.deal.userfield.update #
POST /crm.dealcategory.add Create a New Deal Direction crm.dealcategory.add #
POST /crm.dealcategory.default.get Get Default Deal Category Settings crm.dealcategory.default.get #
POST /crm.dealcategory.default.set Set Default Deal Category Settings crm.dealcategory.default.set #
POST /crm.dealcategory.delete Delete Deal Direction crm.dealcategory.delete #
POST /crm.dealcategory.fields Get Descriptions of Fields for Deal Categories crm.dealcategory.fields #
POST /crm.dealcategory.get Get Deal Direction crm.dealcategory.get #
POST /crm.dealcategory.list Filter Deal Categories crm.dealcategory.list #
POST /crm.dealcategory.stage.list Get a List of Deal Stages for the crm.dealcategory.stage.list Endpoint #
POST /crm.dealcategory.status Get the Identifier of the Directory Where Deal Stages are Stored: crm.dealcategory.status #
POST /crm.dealcategory.update Update Deal Direction crm.dealcategory.update #
POST /crm.documentgenerator.document.add Create a New Document crm.documentgenerator.document.add #
POST /crm.documentgenerator.document.delete Delete Document crm.documentgenerator.document.delete #
POST /crm.documentgenerator.document.enablepublicurl Enable or Disable Public Link for Document crm.documentgenerator.document.enablepublicurl #
POST /crm.documentgenerator.document.get Get Document crm.documentgenerator.document.get #
POST /crm.documentgenerator.document.getfields Get Document Fields crm.documentgenerator.document.getfields #
POST /crm.documentgenerator.document.list Get a List of Documents crm.documentgenerator.document.list #
POST /crm.documentgenerator.document.update Update Document crm.documentgenerator.document.update #
POST /crm.documentgenerator.document.upload Upload Document crm.documentgenerator.document.upload #
POST /crm.documentgenerator.numerator.add Add a New Numerator crm.documentgenerator.numerator.add #
POST /crm.documentgenerator.numerator.delete Delete crm.documentgenerator.numerator.delete #
POST /crm.documentgenerator.numerator.get Get Information About the Numerator crm.documentgenerator.numerator.get #
POST /crm.documentgenerator.numerator.list Get the List of Numerators crm.documentgenerator.numerator.list #
POST /crm.documentgenerator.numerator.update Update the crm.documentgenerator.numerator.update #
POST /crm.documentgenerator.template.add Add a New Template crm.documentgenerator.template.add #
POST /crm.documentgenerator.template.delete Delete Document Template crm.documentgenerator.template.delete #
POST /crm.documentgenerator.template.get Get Information About Document Template by Id crm.documentgenerator.template.get #
POST /crm.documentgenerator.template.getfields Get Document Template Fields crm.documentgenerator.template.getfields #
POST /crm.documentgenerator.template.list Get a List of Document Templates crm.documentgenerator.template.list #
POST /crm.documentgenerator.template.update Update Existing Document Template crm.documentgenerator.template.update #
POST /crm.duplicate.findbycomm Get leads, contacts, and companies with matching data crm.duplicate.findbycomm #
POST /crm.duplicate.volatileType.fields Get a List of Fields for Duplicate Search crm.duplicate.volatileType.fields #
POST /crm.duplicate.volatileType.list Get a List of Custom Fields Used in Duplicate Search crm.duplicate.volatileType.list #
POST /crm.duplicate.volatileType.register Add Field to Duplicate Search crm.duplicate.volatileType.register #
POST /crm.duplicate.volatileType.unregister Remove Field from Duplicate Search crm.duplicate.volatileType.unregister #
POST /crm.entity.mergeBatch Merge Duplicates crm.entity.mergeBatch #
POST /crm.enum.activitydirection Get Activity Direction Enumeration Elements crm.enum.activitydirection #
POST /crm.enum.activitynotifytype Get Enumeration Items for "Activity Notification Type" crm.enum.activitynotifytype #
POST /crm.enum.activitypriority Get Enumeration Items for "Activity Priorities" crm.enum.activitypriority #
POST /crm.enum.activitystatus Get Enumeration Elements "Status" crm.enum.activitystatus #
POST /crm.enum.activitytype Get Enumeration Elements "Activity Types" crm.enum.activitytype #
POST /crm.enum.addresstype Get Address Types crm.enum.addresstype #
POST /crm.enum.contenttype Get Enumeration Elements of "Description Type" crm.enum.contenttype #
POST /crm.enum.fields Get Fields of CRM Enumeration Elements crm.enum.fields #
POST /crm.enum.getorderownertypes Get Object Types for Order Binding crm.enum.getorderownertypes #
POST /crm.enum.ownertype Get CRM Object Types crm.enum.ownertype #
POST /crm.enum.settings.mode Get Description of CRM Operation Modes crm.enum.settings.mode #
POST /crm.invoice.add Add Invoice crm.invoice.add #
POST /crm.invoice.delete Delete invoice crm.invoice.delete #
POST /crm.invoice.fields Get Invoice Fields and Associated Products crm.invoice.fields #
POST /crm.invoice.get Get Invoice by ID crm.invoice.get #
POST /crm.invoice.list Get a List of Invoices crm.invoice.list #
POST /crm.invoice.recurring.add Add Configuration for Recurring Invoice crm.invoice.recurring.add #
POST /crm.invoice.recurring.delete Delete the Recurring Invoice Setting crm.invoice.recurring.delete #
POST /crm.invoice.recurring.expose Create a New Invoice from the Template crm.invoice.recurring.expose #
POST /crm.invoice.recurring.fields Get Full Template of Recurring Invoice Fields crm.invoice.recurring.fields #
POST /crm.invoice.recurring.get Get Recurring Invoice Settings by ID crm.invoice.recurring.get #
POST /crm.invoice.recurring.list Get a List of Recurring Invoice Settings by Filter crm.invoice.recurring.list #
POST /crm.invoice.recurring.update Change Settings for Recurring Invoice crm.invoice.recurring.update #
POST /crm.invoice.status.add Create a New Invoice Status crm.invoice.status.add #
POST /crm.invoice.status.delete Delete Invoice Status crm.invoice.status.delete #
POST /crm.invoice.status.fields Get Invoice Status Fields crm.invoice.status.fields #
POST /crm.invoice.status.get Get Invoice Status by ID crm.invoice.status.get #
POST /crm.invoice.status.list Get a List of Invoice Statuses crm.invoice.status.list #
POST /crm.invoice.status.update Update Invoice Status crm.invoice.status.update #
POST /crm.invoice.update Update Invoice crm.invoice.update #
POST /crm.invoice.userfield.add Create a Custom Field for Invoices crm.invoice.userfield.add #
POST /crm.invoice.userfield.delete Delete Custom Field of Invoices crm.invoice.userfield.delete #
POST /crm.invoice.userfield.get Get User Field by ID crm.invoice.userfield.get #
POST /crm.invoice.userfield.list Get a List of Custom Fields by Filter crm.invoice.userfield.list #
POST /crm.invoice.userfield.update Update Custom Field crm.invoice.userfield.update #
POST /crm.item.add Create a New CRM Entity crm.item.add #
POST /crm.item.batchImport Importing a Batch of CRM Records: crm.item.batchImport #
POST /crm.item.delete Delete CRM Item: crm.item.delete #
POST /crm.item.delivery.get Get Delivery Information by ID crm.item.delivery.get #
POST /crm.item.delivery.list Get the list of deliveries for a CRM entity crm.item.delivery.list #
POST /crm.item.details.configuration.forceCommonScopeForAll Set a Common Detail Form for All Users crm.item.details.configuration.forceCommonScopeForAll #
POST /crm.item.details.configuration.reset Reset Item Card Parameters crm.item.details.configuration.reset #
POST /crm.item.details.configuration.set Set Parameters for crm.item.details.configuration.set #
POST /crm.item.get Get Element by Id crm.item.get #
POST /crm.item.import Import One Record crm.item.import #
POST /crm.item.list Get a List of CRM Items: crm.item.list #
POST /crm.item.payment.add Add Payment crm.item.payment.add #
POST /crm.item.payment.delete Delete Payment crm.item.payment.delete #
POST /crm.item.payment.delivery.add Add Delivery Item to Payment crm.item.payment.delivery.add #
POST /crm.item.payment.delivery.delete Remove Delivery Item from Payment crm.item.payment.delivery.delete #
POST /crm.item.payment.delivery.list Get Delivery Item List by Specific Payment crm.item.payment.delivery.list #
POST /crm.item.payment.delivery.setDelivery Reassign Delivery Position to Another Document crm.item.payment.delivery.setDelivery #
POST /crm.item.payment.get Get Payment Information crm.item.payment.get #
POST /crm.item.payment.list Get the list of payments crm.item.payment.list #
POST /crm.item.payment.pay Change Payment Status to "Paid" crm.item.payment.pay #
POST /crm.item.payment.product.add Adding a Product Item to Payment crm.item.payment.product.add #
POST /crm.item.payment.product.delete Remove Product Item from Payment crm.item.payment.product.delete #
POST /crm.item.payment.product.list Get a List of Payment Product Items crm.item.payment.product.list #
POST /crm.item.payment.product.setQuantity Change Product Quantity crm.item.payment.product.setQuantity #
POST /crm.item.payment.unpay Change Payment Status to "Unpaid" crm.item.payment.unpay #
POST /crm.item.payment.update Update Payment Fields crm.item.payment.update #
POST /crm.item.productrow.add Add Product Row to CRM Object crm.item.productrow.add #
POST /crm.item.productrow.delete Delete product row from CRM object crm.item.productrow.delete #
POST /crm.item.productrow.fields Get the list of fields for product rows crm.item.productrow.fields #
POST /crm.item.productrow.get Get information about a product item by id crm.item.productrow.get #
POST /crm.item.productrow.getAvailableForPayment Get Unpaid Product Rows of CRM Object crm.item.productrow.getAvailableForPayment #
POST /crm.item.productrow.list Get product rows of the CRM object crm.item.productrow.list #
POST /crm.item.productrow.set Save Product Row of CRM Object crm.item.productrow.set #
POST /crm.item.productrow.update Update the product row of a CRM object crm.item.productrow.update #
POST /crm.lead.add Create a New Lead crm.lead.add #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bitrix24/refs/heads/main/openapi/bitrix24-crm-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/bitrix24-crm-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bitrix24-crm-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Bitrix24 REST BIconnector CRM API
  version: 1.0.0
  description: 'Bitrix24 REST API provides access to CRM, tasks, drive, chats, telephony, e-commerce, automation, and other modules. Documentation: https://apidocs.bitrix24.com'
  contact:
    name: Bitrix24 Developer Support
    url: https://apidocs.bitrix24.com/support.html
  license:
    name: MIT
    url: https://github.com/bitrix-tools/b24-rest-docs/blob/main/LICENSE
  x-logo:
    url: https://apidocs.bitrix24.com/_images/bitrix24logo.svg
servers:
- url: https://{portal}.bitrix24.com/rest
  description: Your Bitrix24 portal (cloud)
  variables:
    portal:
      default: your-portal
      description: Subdomain of your Bitrix24 portal
- url: https://{host}/rest
  description: On-Premise Bitrix24 installation
  variables:
    host:
      default: your-bitrix24.example.com
      description: Host of your on-premise installation
security:
- AccessToken: []
tags:
- name: CRM
paths:
  /crm.activity.add:
    post:
      summary: Add System Activity crm.activity.add
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. Development of this method has been halted. Please use [crm.activity.todo.add](../todo/crm-activity-todo-add.md). The method `crm.activity.add` creates a new system activity.
      operationId: crm_activity_add
      tags:
      - CRM
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/activity-base/crm-activity-add.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                fields:
                  type: array
                  items: {}
                  description: '| An array of values for the activity fields in the following structure:'
                Field:
                  type: string
                  description: '`type` | Description ||'
                OWNER_ID:
                  type: integer
                  description: '| Identifier of the CRM entity ||'
                OWNER_TYPE_ID:
                  type: integer
                  description: '| Identifier of the CRM object type ||'
                TYPE_ID:
                  type: string
                  description: '| Type of the activity. To get available activity types, use the method crm.enum.activitytype.'
                ASSOCIATED_ENTITY_ID:
                  type: integer
                  description: '| Identifier of the entity associated with the activity ||'
                COMMUNICATIONS:
                  type: string
                  description: '| Description of communication ||'
                DEADLINE:
                  type: string
                  format: date-time
                  description: '| Date and time of the activity''s deadline. This field is not set directly; the value is taken from START_TIME for calls and meetings and from END_TIME for tasks ||'
                DESCRIPTION:
                  type: string
                  description: '| Text description of the activity ||'
                DESCRIPTION_TYPE:
                  type: string
                  description: '| Type of description ||'
                DIRECTION:
                  type: string
                  description: '| Direction of the activity: incoming/outgoing. Relevant for calls and emails, not used for meetings ||'
                END_TIME:
                  type: string
                  format: date-time
                  description: '| Time of activity completion | ||'
                FILES:
                  type: string
                  description: '| Files added to the activity ||'
                LOCATION:
                  type: string
                  description: '| Location ||'
                NOTIFY_TYPE:
                  type: string
                  description: '| Type of notification ||'
                ORIGINATOR_ID:
                  type: string
                  description: '| Identifier of the data source, used only for linking to an external source ||'
                ORIGIN_ID:
                  type: string
                  description: '| Identifier of the entity in the data source, used only for linking to an external source ||'
                ORIGIN_VERSION:
                  type: string
                  description: '| Original version, used to protect data from accidental overwriting by an external system. If the data was imported and not modified in the external system, such data can be edited in CRM without fear that the next export will lead to data overwriting ||'
                PRIORITY:
                  type: string
                  description: '| Priority ||'
                PROVIDER_DATA:
                  type: string
                  description: '| Additional provider data ||'
                PROVIDER_GROUP_ID:
                  type: string
                  description: '| Identifier of the provider group ||'
                PROVIDER_ID:
                  type: string
                  description: '| Identifier of the provider ||'
                PROVIDER_TYPE_ID:
                  type: string
                  description: '| Identifier of the provider type, status from the directory ||'
                PROVIDER_PARAMS:
                  type: object
                  description: '| Additional provider parameters ||'
                RESPONSIBLE_ID:
                  type: string
                  description: '| Identifier of the user responsible for the activity ||'
                SETTINGS:
                  type: object
                  description: '| Additional settings ||'
                START_TIME:
                  type: string
                  format: date-time
                  description: '| Time when the activity starts ||'
                STATUS:
                  type: string
                  description: '| Status of the activity ||'
                SUBJECT:
                  type: string
                  description: '| Additional description of the activity ||'
                WEBDAV_ELEMENTS:
                  type: string
                  description: '| Added files. Deprecated, kept for compatibility ||'
                IS_INCOMING_CHANNEL:
                  type: string
                  maxLength: 1
                  description: '| Flag indicating whether the activity was created from an incoming channel (`Y`/`N`) ||'
              required:
              - fields
              - OWNER_ID
              - OWNER_TYPE_ID
              - TYPE_ID
              - COMMUNICATIONS
              - RESPONSIBLE_ID
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                fields:
                  type: array
                  items: {}
                  description: '| An array of values for the activity fields in the following structure:'
                Field:
                  type: string
                  description: '`type` | Description ||'
                OWNER_ID:
                  type: integer
                  description: '| Identifier of the CRM entity ||'
                OWNER_TYPE_ID:
                  type: integer
                  description: '| Identifier of the CRM object type ||'
                TYPE_ID:
                  type: string
                  description: '| Type of the activity. To get available activity types, use the method crm.enum.activitytype.'
                ASSOCIATED_ENTITY_ID:
                  type: integer
                  description: '| Identifier of the entity associated with the activity ||'
                COMMUNICATIONS:
                  type: string
                  description: '| Description of communication ||'
                DEADLINE:
                  type: string
                  format: date-time
                  description: '| Date and time of the activity''s deadline. This field is not set directly; the value is taken from START_TIME for calls and meetings and from END_TIME for tasks ||'
                DESCRIPTION:
                  type: string
                  description: '| Text description of the activity ||'
                DESCRIPTION_TYPE:
                  type: string
                  description: '| Type of description ||'
                DIRECTION:
                  type: string
                  description: '| Direction of the activity: incoming/outgoing. Relevant for calls and emails, not used for meetings ||'
                END_TIME:
                  type: string
                  format: date-time
                  description: '| Time of activity completion | ||'
                FILES:
                  type: string
                  description: '| Files added to the activity ||'
                LOCATION:
                  type: string
                  description: '| Location ||'
                NOTIFY_TYPE:
                  type: string
                  description: '| Type of notification ||'
                ORIGINATOR_ID:
                  type: string
                  description: '| Identifier of the data source, used only for linking to an external source ||'
                ORIGIN_ID:
                  type: string
                  description: '| Identifier of the entity in the data source, used only for linking to an external source ||'
                ORIGIN_VERSION:
                  type: string
                  description: '| Original version, used to protect data from accidental overwriting by an external system. If the data was imported and not modified in the external system, such data can be edited in CRM without fear that the next export will lead to data overwriting ||'
                PRIORITY:
                  type: string
                  description: '| Priority ||'
                PROVIDER_DATA:
                  type: string
                  description: '| Additional provider data ||'
                PROVIDER_GROUP_ID:
                  type: string
                  description: '| Identifier of the provider group ||'
                PROVIDER_ID:
                  type: string
                  description: '| Identifier of the provider ||'
                PROVIDER_TYPE_ID:
                  type: string
                  description: '| Identifier of the provider type, status from the directory ||'
                PROVIDER_PARAMS:
                  type: object
                  description: '| Additional provider parameters ||'
                RESPONSIBLE_ID:
                  type: string
                  description: '| Identifier of the user responsible for the activity ||'
                SETTINGS:
                  type: object
                  description: '| Additional settings ||'
                START_TIME:
                  type: string
                  format: date-time
                  description: '| Time when the activity starts ||'
                STATUS:
                  type: string
                  description: '| Status of the activity ||'
                SUBJECT:
                  type: string
                  description: '| Additional description of the activity ||'
                WEBDAV_ELEMENTS:
                  type: string
                  description: '| Added files. Deprecated, kept for compatibility ||'
                IS_INCOMING_CHANNEL:
                  type: string
                  maxLength: 1
                  description: '| Flag indicating whether the activity was created from an incoming channel (`Y`/`N`) ||'
              required:
              - fields
              - OWNER_ID
              - OWNER_TYPE_ID
              - TYPE_ID
              - COMMUNICATIONS
              - RESPONSIBLE_ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - crm
  /crm.activity.badge.add:
    post:
      summary: Add Badge crm.activity.badge.add
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.badge.add` adds a new badge for a configurable activity.
      operationId: crm_activity_badge_add
      tags:
      - CRM
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-add.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                Field:
                  type: string
                  description: '| Description ||'
                code:
                  type: string
                  description: '| Badge code, for example `missedCall` ||'
                type:
                  type: string
                  description: '| Badge type ||'
              required:
              - code
              - type
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                Field:
                  type: string
                  description: '| Description ||'
                code:
                  type: string
                  description: '| Badge code, for example `missedCall` ||'
                type:
                  type: string
                  description: '| Badge type ||'
              required:
              - code
              - type
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - crm
  /crm.activity.badge.delete:
    post:
      summary: Delete Badge by Code crm.activity.badge.delete
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.badge.delete` removes a badge.
      operationId: crm_activity_badge_delete
      tags:
      - CRM
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-delete.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                Field:
                  type: string
                  description: '| Description ||'
                code:
                  type: string
                  description: '| Badge code, for example `missedCall` ||'
              required:
              - code
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                Field:
                  type: string
                  description: '| Description ||'
                code:
                  type: string
                  description: '| Badge code, for example `missedCall` ||'
              required:
              - code
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - crm
  /crm.activity.badge.get:
    post:
      summary: Get Badge Information by Code crm.activity.badge.get
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.badge.get` will return an array containing [badge fields](./index.md#badge-record-fields).
      operationId: crm_activity_badge_get
      tags:
      - CRM
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-get.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                Field:
                  type: string
                  description: '| Description ||'
                code:
                  type: string
                  description: '| Badge code, for example `missedCall` ||'
              required:
              - code
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                Field:
                  type: string
                  description: '| Description ||'
                code:
                  type: string
                  description: '| Badge code, for example `missedCall` ||'
              required:
              - code
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - crm
  /crm.activity.badge.list:
    post:
      summary: Get the list of badges crm.activity.badge.list
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.badge.list` retrieves a list of available badges. It will return an array containing a list of all registered badges. Each element of the array contains [badge fields](./index.md#badge-record-fields).
      operationId: crm_activity_badge_list
      tags:
      - CRM
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/configurable/badges/crm-activity-badge-list.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
          application/x-www-form-urlencoded:
            schema:
              type: object
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - crm
  /crm.activity.binding.add:
    post:
      summary: Add a deal binding to a CRM entity crm.activity.binding.add
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.binding.add` adds a binding of a deal to a CRM entity. The maximum number of bindings for a single deal is 100 CRM entities.
      operationId: crm_activity_binding_add
      tags:
      - CRM
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/binding/crm-activity-binding-add.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                activityId:
                  type: integer
                  description: '| Integer identifier of the deal in the timeline, for example `999` ||'
                entityTypeId:
                  type: integer
                  description: '| Integer identifier of the CRM object type to which the deal should be bound, for example `2` for a deal ||'
                entityId:
                  type: integer
                  description: '| Integer identifier of the CRM entity to which the deal should be bound, for example `1`  ||'
              required:
              - activityId
              - entityTypeId
              - entityId
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                activityId:
                  type: integer
                  description: '| Integer identifier of the deal in the timeline, for example `999` ||'
                entityTypeId:
                  type: integer
                  description: '| Integer identifier of the CRM object type to which the deal should be bound, for example `2` for a deal ||'
                entityId:
                  type: integer
                  description: '| Integer identifier of the CRM entity to which the deal should be bound, for example `1`  ||'
              required:
              - activityId
              - entityTypeId
              - entityId
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - crm
  /crm.activity.binding.delete:
    post:
      summary: Delete the deal's connection with the CRM entity crm.activity.binding.delete
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.binding.delete` removes the connection of a deal with a CRM entity. If the deal is linked to only one entity, this connection cannot be deleted.
      operationId: crm_activity_binding_delete
      tags:
      - CRM
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/binding/crm-activity-binding-delete.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                activityId:
                  type: integer
                  description: '| Integer identifier of the deal in the timeline, for example `999` ||'
                entityTypeId:
                  type: integer
                  description: '| Integer identifier of the CRM entity type to which the deal connection is being removed, for example `2` for a deal ||'
                entityId:
                  type: integer
                  description: '| Integer identifier of the CRM entity to which the deal connection is being removed, for example `1` ||'
              required:
              - activityId
              - entityTypeId
              - entityId
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                activityId:
                  type: integer
                  description: '| Integer identifier of the deal in the timeline, for example `999` ||'
                entityTypeId:
                  type: integer
                  description: '| Integer identifier of the CRM entity type to which the deal connection is being removed, for example `2` for a deal ||'
                entityId:
                  type: integer
                  description: '| Integer identifier of the CRM entity to which the deal connection is being removed, for example `1` ||'
              required:
              - activityId
              - entityTypeId
              - entityId
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - crm
  /crm.activity.binding.list:
    post:
      summary: Get a list of all bindings for the deal crm.activity.binding.list
      description: 'If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.binding.list` retrieves a list of all bindings for the deal. The method will return an array, where each element will be an array containing: - `entityTypeId` — integer identifier of the [CRM object type](../../../data-types.md#object_type)'
      operationId: crm_activity_binding_list
      tags:
      - CRM
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/binding/crm-activity-binding-list.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                activityId:
                  type: integer
                  description: '| Integer identifier of the deal in the timeline, for example `999` ||'
              required:
              - activityId
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                activityId:
                  type: integer
                  description: '| Integer identifier of the deal in the timeline, for example `999` ||'
              required:
              - activityId
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - crm
  /crm.activity.binding.move:
    post:
      summary: Update the Deal's Connection with the CRM Entity crm.activity.binding.move
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.binding.move` updates the connection of a deal with a CRM entity.
      operationId: crm_activity_binding_move
      tags:
      - CRM
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/binding/crm-activity-binding-move.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                activityId:
                  type: integer
                  description: '| The identifier of the deal in the timeline, for example, `999` ||'
                sourceEntityTypeId:
                  type: integer
                  description: '| Identifier of the CRM object type to which the deal is linked, for example, `2` for a deal ||'
                sourceEntityId:
                  type: integer
                  description: '| The identifier of the CRM entity to which the deal is linked, for example, `1` ||'
                targetEntityTypeId:
                  type: integer
                  description: '| Identifier of the CRM object type to which the deal should be linked, for example, `2` for a deal ||'
                targetEntityId:
                  type: integer
                  description: '| The identifier of the CRM entity to which the deal should be linked, for example, `100` ||'
              required:
              - activityId
              - sourceEntityTypeId
              - sourceEntityId
              - targetEntityTypeId
              - targetEntityId
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                activityId:
                  type: integer
                  description: '| The identifier of the deal in the timeline, for example, `999` ||'
                sourceEntityTypeId:
                  type: integer
                  description: '| Identifier of the CRM object type to which the deal is linked, for example, `2` for a deal ||'
                sourceEntityId:
                  type: integer
                  description: '| The identifier of the CRM entity to which the deal is linked, for example, `1` ||'
                targetEntityTypeId:
                  type: integer
                  description: '| Identifier of the CRM object type to which the deal should be linked, for example, `2` for a deal ||'
                targetEntityId:
                  type: integer
                  description: '| The identifier of the CRM entity to which the deal should be linked, for example, `100` ||'
              required:
              - activityId
              - sourceEntityTypeId
              - sourceEntityId
              - targetEntityTypeId
              - targetEntityId
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - crm
  /crm.activity.communication.fields:
    post:
      summary: Get Description of Communication crm.activity.communication.fields
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `crm.activity.communication.fields` returns the description of communication for an activity. Communications store phone numbers in calls, email addresses in e-mails, and names in meetings.
      operationId: crm_activity_communication_fields
      tags:
      - CRM
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/crm/timeline/activities/activity-base/crm-activity-communication-fields.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
          application/x-www-form-urlencoded:
            schema:
              type: object
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
       

# --- truncated at 32 KB (1282 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitrix24/refs/heads/main/openapi/bitrix24-crm-api-openapi.yml