{ "opencollection": "1.0.0", "info": { "name": "Bitrix24 REST BIconnector CRM API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "items": [ { "info": { "name": "CRM", "type": "folder" }, "items": [ { "info": { "name": "Add System Activity crm.activity.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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." }, { "info": { "name": "Add Badge crm.activity.badge.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.badge.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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." }, { "info": { "name": "Delete Badge by Code crm.activity.badge.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.badge.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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." }, { "info": { "name": "Get Badge Information by Code crm.activity.badge.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.badge.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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)." }, { "info": { "name": "Get the list of badges crm.activity.badge.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.badge.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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)." }, { "info": { "name": "Add a deal binding to a CRM entity crm.activity.binding.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.binding.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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." }, { "info": { "name": "Delete the deal's connection with the CRM entity crm.activity.binding.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.binding.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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." }, { "info": { "name": "Get a list of all bindings for the deal crm.activity.binding.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.binding.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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)" }, { "info": { "name": "Update the Deal's Connection with the CRM Entity crm.activity.binding.move", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.binding.move", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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." }, { "info": { "name": "Get Description of Communication crm.activity.communication.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.communication.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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." }, { "info": { "name": "Add Configurable CRM Activity crm.activity.configurable.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.configurable.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.configurable.add` adds a configurable activity to the timeline. The method can only be called in the context of an [application](https://helpdesk.bitrix24.com/examples/app.zip)." }, { "info": { "name": "Get Configurable Activity by ID crm.activity.configurable.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.configurable.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.configurable.get` returns information about a configurable activity. The method can only be called in the context of an [application](https://helpdesk.bitrix24.com/examples/app.zip)." }, { "info": { "name": "Update Configurable Activity crm.activity.configurable.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.configurable.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.configurable.update` makes changes to a configurable activity. The method can only be called in the context of the [application](https://helpdesk.bitrix24.com/examples/app.zip) that created it." }, { "info": { "name": "Delete activity crm.activity.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.delete` removes an activity of any type." }, { "info": { "name": "Get a list of fields for crm.activity.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.fields` returns the description of the fields of the system activity." }, { "info": { "name": "Get information about the activity by ID crm.activity.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.get` returns information about the activity by its ID." }, { "info": { "name": "Delete a set of additional content blocks in the CRM activity crm.activity.layout.blocks.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.layout.blocks.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.layout.blocks.delete` removes a set of additional content blocks for a activity. Within the application, only the set of additional content blocks that was installed through this application can be deleted." }, { "info": { "name": "Get a Set of Additional Content Blocks in the activity crm.activity.layout.blocks.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.layout.blocks.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.layout.blocks.get` retrieves a set of additional content blocks for a activity. Within the application, you can only obtain the set of additional content blocks that has been installed through this application." }, { "info": { "name": "Set a set of additional content blocks in the activity crm.activity.layout.blocks.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.layout.blocks.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.layout.blocks.set` sets a set of additional content blocks for the activity. Setting a new set of additional content blocks in the activity will overwrite the previously added set within the same application. Setting a set of additional content blocks can" }, { "info": { "name": "Get the list of activities crm.activity.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.list` returns a list of activities based on the filter, considering the access permissions of the current user." }, { "info": { "name": "Add Universal Activity crm.activity.todo.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.todo.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.todo.add` adds a universal activity to the timeline." }, { "info": { "name": "Update universal deal crm.activity.todo.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.todo.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.todo.update` updates a universal deal." }, { "info": { "name": "Update the color of the universal deal crm.activity.todo.updateColor", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.todo.updateColor", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.todo.updateColor` updates the color of the universal deal." }, { "info": { "name": "Update Deadline for Universal Activity crm.activity.todo.updateDeadline", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.todo.updateDeadline", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.todo.updateDeadline` changes the deadline of a universal activity." }, { "info": { "name": "Update the description of the universal activity crm.activity.todo.updateDescription", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.todo.updateDescription", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.todo.updateDescription` changes the description in the universal activity." }, { "info": { "name": "Update the responsible user for the universal activity crm.activity.todo.updateResponsibleUser", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.todo.updateResponsibleUser", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.todo.updateResponsibleUser` updates the responsible user for the universal activity." }, { "info": { "name": "Add Custom Activity Type crm.activity.type.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.type.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.type.add` registers a custom activity type by specifying a name and an icon." }, { "info": { "name": "Delete Custom Activity Type crm.activity.type.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.type.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.type.delete` removes a custom activity type." }, { "info": { "name": "Get a list of custom activity types crm.activity.type.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.type.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.type.list` retrieves a list of custom activity types registered by the application." }, { "info": { "name": "Update System CRM Activity crm.activity.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.activity.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.update](../todo/crm-activity-todo-update.md). The method `crm.activity.update` updates an existing activity." }, { "info": { "name": "Add Address crm.address.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.address.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method adds a new address for a requisite or lead. For the user, this address appears as the address of a contact, company, or lead. Multiple addresses of different [types](../../auxiliary/enum/crm-enum-address-type.md) can be created, linked to a single requisite." }, { "info": { "name": "Delete address crm.address.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.address.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 deletes an address." }, { "info": { "name": "Get Description of Address Fields crm.address.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.address.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns a formal description of the address fields. No parameters." }, { "info": { "name": "Get a List of Addresses by Filter crm.address.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.address.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns a list of addresses based on the filter. Addresses are moved to the details. In the CRM card, they are displayed as a separate field. Multiple details can be linked to a CRM object. Within a detail, there can be several addresses (each of a different type)." }, { "info": { "name": "Update Address for crm.address.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.address.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method updates the address for a contact or lead." }, { "info": { "name": "Create Digital Workspace crm.automatedsolution.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.automatedsolution.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. - there is a link to the data-types file, need to check that the type crm_dynamic_type is described (from SPAs) This method will create a new digital workspace. In the cloud, the maximum number of digital workspaces depends on the plan. In on-premise, the maximum number depends on tech" }, { "info": { "name": "Delete Digital Workplace crm.automatedsolution.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.automatedsolution.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes an existing digital workplace with the identifier `id`. Deletion of the digital workplace is only possible if there are no bound SPAs associated with it. If there are SPAs, they must first be unbound or reassigned to another workplace before deleting this digital wo" }, { "info": { "name": "Get fields of the digital workplace crm.automatedsolution.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.automatedsolution.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns information about the fields of the digital workplace settings. No parameters." }, { "info": { "name": "Get data about the digital workplace by id crm.automatedsolution.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.automatedsolution.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns information about the digital workplace with the identifier `id`." }, { "info": { "name": "Get a list of digital workspaces crm.automatedsolution.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.automatedsolution.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 will return an array of digital workspace settings. Each element of the array is a structure similar to the response from the request [crm.automatedsolution.get](./crm-automated-solution-get.md)." }, { "info": { "name": "Update Digital Workplace crm.automatedsolution.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.automatedsolution.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. - there is a link to the data-types file, check that the type crm_dynamic_type is described there (from SPAs) This method updates the existing settings of the digital workplace with the identifier `id`. If any of the fields are not provided, their values will remain unchanged." }, { "info": { "name": "Activate the crm.automation.trigger", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.automation.trigger", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. Bitrix24 allows users to create a special custom trigger \"Track Incoming Webhook.\" The user is provided with a ready-made URL of the form" }, { "info": { "name": "Add Trigger crm.automation.trigger.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.automation.trigger.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method adds a trigger. The method can only be executed in the application context, as the added triggers are tied to this application." }, { "info": { "name": "Execute the Trigger crm.automation.trigger.execute", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.automation.trigger.execute", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method initiates the execution of a trigger. The method can only be called in the application context." }, { "info": { "name": "Get the list of triggers crm.automation.trigger.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.automation.trigger.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves a list of applications and triggers. The method can only be executed in the application context. No parameters." }, { "info": { "name": "Create a New Call List crm.calllist.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.calllist.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.calllist.add` creates a new call list." }, { "info": { "name": "Get Information About the Call List crm.calllist.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.calllist.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.calllist.get` returns information about the call list by its identifier, without the list of participants." }, { "info": { "name": "Get the list of call participants crm.calllist.items.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.calllist.items.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.calllist.items.get` returns a list of participants, contacts, or companies, along with the call status." }, { "info": { "name": "Get the list of call lists crm.calllist.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.calllist.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.calllist.list` returns a list of call list activities." }, { "info": { "name": "Get the list of call statuses crm.calllist.statuslist", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.calllist.statuslist", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.calllist.statuslist` returns a list of call statuses. To create a new status, modify, or delete an existing one, use the methods [crm.status.*](../status/index.md)." }, { "info": { "name": "Update Call List Composition crm.calllist.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.calllist.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 `crm.calllist.update` method allows you to add or remove participants from an existing call list and update the associated CRM form." }, { "info": { "name": "Get Product Catalog Fields crm.catalog.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.catalog.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.catalog.getFields](../../../catalog/catalog/catalog-catalog-get-fields.md). This method returns the description of the product catalog fields. No parameters required." }, { "info": { "name": "Get Product Catalog by ID crm.catalog.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.catalog.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.catalog.get](../../../catalog/catalog/catalog-catalog-get.md). This method returns the product catalog by ID." }, { "info": { "name": "Get a List of Product Catalogs crm.catalog.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.catalog.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.catalog.list](../../../catalog/catalog/catalog-catalog-list.md). This method returns a list of product catalogs. It is an implementation of the listing method for product catalogs. See the description of [listing me" }, { "info": { "name": "Add a New Sales Funnel crm.category.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.category.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method creates a new sales funnel (direction) for the CRM object type with the identifier `entityTypeId`." }, { "info": { "name": "Delete Sales Funnel crm.category.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.category.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes a funnel (direction) with the identifier `id`. * Default funnels * Funnels that have at least one element" }, { "info": { "name": "Get Fields of the Sales Funnel crm.category.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.category.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 retrieves information about the fields of the sales funnels (directions) of the CRM object." }, { "info": { "name": "Get the funnel by Id crm.category.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.category.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves information about the funnel (direction) with the identifier `id`." }, { "info": { "name": "Get the list of Sales Funnels crm.category.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.category.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 retrieves a list of sales funnels (directions) that belong to the CRM object type with the identifier `entityTypeId`. The list of returned funnels is filtered by access permissions. This means that if a user does not have permission to read a specific funnel, it will not " }, { "info": { "name": "Update Sales Funnel crm.category.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.category.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method updates the funnel (direction) with the identifier `id`, setting new values for the fields from `fields`. If any field is missing in `fields`, its value will remain unchanged." }, { "info": { "name": "Create a New Company crm.company.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.add](../universal/crm-item-add.md). The method `crm.company.add` creates a new company." }, { "info": { "name": "Add Contact to the Specified Company crm.company.contact.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.contact.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.company.contact.add` adds a contact to the specified company." }, { "info": { "name": "Delete Contact from Specified Company crm.company.contact.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.contact.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.company.contact.delete` removes a contact from the specified company." }, { "info": { "name": "Get Fields for Company-Contact Connection crm.company.contact.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.contact.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.company.contact.fields` returns the description of fields for the company-contact connection." }, { "info": { "name": "Clear the set of contacts associated with the specified company crm.company.contact.items.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.contact.items.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.company.contact.items.delete` clears the set of contacts associated with the specified company." }, { "info": { "name": "Retrieve a Set of Contacts Associated with a Specified Company crm.company.contact.items.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.contact.items.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.company.contact.items.get` returns a set of contacts associated with the specified company." }, { "info": { "name": "Set a Set of Contacts Associated with the Specified Company crm.company.contact.items.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.contact.items.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.company.contact.items.set` sets a set of contacts associated with the specified company." }, { "info": { "name": "Delete Company crm.company.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.delete](../universal/crm-item-delete.md). The method `crm.company.delete` removes a company." }, { "info": { "name": "Set Common Company Card for All Users crm.company.details.configuration.forceCommonScopeForAll", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.details.configuration.forceCommonScopeForAll", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.details.configuration.forceCommonScopeForAll](../../universal/item-details-configuration/crm-item-details-configuration-forceCommonScopeForAll.md). The method `crm.company.details.configuration.forceCommonScopeForA" }, { "info": { "name": "Get Parameters for crm.company.details.configuration.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.details.configuration.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.details.configuration.get](../../universal/item-details-configuration/crm-item-details-configuration-get.md). The method `crm.company.details.configuration.get` retrieves the settings for company cards: it reads th" }, { "info": { "name": "Reset Company Card Settings: crm.company.details.configuration.reset", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.details.configuration.reset", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.item.details.configuration.reset](../../universal/item-details-configuration/crm-item-details-configuration-reset.md). The method `crm.company.details.configuration.reset` resets the settings of company cards: it removes th" }, { "info": { "name": "Set Parameters for crm.company.details.configuration.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.details.configuration.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.details.configuration.set](../../universal/item-details-configuration/crm-item-details-configuration-set.md). The method `crm.company.details.configuration.set` sets the settings for company cards: it records the p" }, { "info": { "name": "Get Company Fields Description crm.company.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.fields](../universal/crm-item-fields.md). The method `crm.company.fields` returns the description of company fields, including [custom fields](./userfields/index.md)." }, { "info": { "name": "Get Company Information crm.company.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.get](../universal/crm-item-get.md). The method `crm.company.get` returns a company by its identifier." }, { "info": { "name": "Get a List of Companies by Filter crm.company.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.list](../universal/crm-item-list.md). The method `crm.company.list` returns a list of companies based on a filter. It is an implementation of the [list method](../../../settings/how-to-call-rest-api/list-methods-pecul" }, { "info": { "name": "Update Existing Company crm.company.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.update](../universal/crm-item-update.md). The method `crm.company.update` updates an existing company." }, { "info": { "name": "Create a Custom Field for Companies crm.company.userfield.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.userfield.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.company.userfield.add` creates a new custom field for companies." }, { "info": { "name": "Delete Custom Field for Companies crm.company.userfield.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.userfield.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.company.userfield.delete` removes a custom field for companies." }, { "info": { "name": "Get Company Custom Field by ID crm.company.userfield.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.userfield.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.company.userfield.get` returns a company custom field by its ID." }, { "info": { "name": "Get a list of custom fields for companies crm.company.userfield.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.userfield.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.company.userfield.list` returns a list of custom fields for companies based on the filter." }, { "info": { "name": "Update Company User Field crm.company.userfield.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.company.userfield.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.company.userfield.update` updates an existing company user field." }, { "info": { "name": "Create a New Contact crm.contact.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.add](../universal/crm-item-add.md). The method `crm.contact.add` creates a new contact." }, { "info": { "name": "Add a Company to the Specified Contact crm.contact.company.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.company.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.contact.company.add` adds a company to the specified contact." }, { "info": { "name": "Remove a company from the specified contact crm.contact.company.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.company.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.contact.company.delete` removes a company from the specified contact." }, { "info": { "name": "Get Fields for Contact-Company crm.contact.company.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.company.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.contact.company.fields` returns the description of fields for the contact-company relationship. No parameters." }, { "info": { "name": "Clear the set of companies associated with the specified contact crm.contact.company.items.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.company.items.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.contact.company.items.delete` clears the set of companies associated with the specified contact." }, { "info": { "name": "Get a set of companies associated with the specified contact crm.contact.company.items.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.company.items.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.contact.company.items.get` returns a set of companies associated with the specified contact." }, { "info": { "name": "Set the set of companies associated with the specified contact crm.contact.company.items.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.company.items.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.contact.company.items.set` sets the set of companies associated with the specified contact." }, { "info": { "name": "Delete Contact crm.contact.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.delete](../universal/crm-item-delete.md). The method `crm.contact.delete` removes a contact and all associated objects." }, { "info": { "name": "Set a Common Contact Card for All Users crm.contact.details.configuration.forceCommonScopeForAll", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.details.configuration.forceCommonScopeForAll", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.details.configuration.forceCommonScopeForAll](../../universal/item-details-configuration/crm-item-details-configuration-forceCommonScopeForAll.md). This method allows you to enforce a common contact card for all us" }, { "info": { "name": "Get Parameters of crm.contact.details.configuration.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.details.configuration.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.details.configuration.get](../../universal/item-details-configuration/crm-item-details-configuration-get.md). This method retrieves the settings for contact cards: it reads the personal settings of the specified us" }, { "info": { "name": "Resetting the Parameters of crm.contact.details.configuration.reset", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.details.configuration.reset", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.details.configuration.reset](../../universal/item-details-configuration/crm-item-details-configuration-reset.md). This method resets the contact card settings: it removes the personal settings of the specified user" }, { "info": { "name": "Set Parameters for the Individual Card crm.contact.details.configuration.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.details.configuration.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.details.configuration.set](../../universal/item-details-configuration/crm-item-details-configuration-set.md). This method sets the contact card settings: it writes personal settings for the specified user or shared" }, { "info": { "name": "Get Contact Fields crm.contact.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.fields](../universal/crm-item-fields.md). This method returns the description of contact fields, including custom fields. No parameters are required." }, { "info": { "name": "Get Contact by Id crm.contact.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.item.get](../universal/crm-item-get.md). The method `crm.contact.get` returns a contact by its identifier. To retrieve a list of companies associated with the contact, use the method [`crm.contact.company.items.get`](company/c" }, { "info": { "name": "Get a List of Contacts crm.contact.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.list](../universal/crm-item-list.md). The method `crm.contact.list` returns a list of contacts based on a filter. It is an implementation of the list method for contacts. To retrieve a list of companies associated wit" }, { "info": { "name": "Update Contact crm.contact.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 discontinued. Please use [crm.item.update](../universal/crm-item-update.md). The method `crm.contact.update` updates an existing contact. It is recommended to pass the complete set of address fields when updating an address." }, { "info": { "name": "Create a Custom Field for Contacts crm.contact.userfield.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.userfield.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.contact.userfield.add` creates a new custom field for contacts." }, { "info": { "name": "Delete Custom Contact Field crm.contact.userfield.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.userfield.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.contact.userfield.delete` removes a custom contact field." }, { "info": { "name": "Get Custom Contact Field by Id crm.contact.userfield.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.userfield.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.contact.userfield.get` returns a custom contact field by its identifier." }, { "info": { "name": "Get a list of custom fields for contacts crm.contact.userfield.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.userfield.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.contact.userfield.list` returns a list of custom fields for contacts based on a filter. It also outputs information about these fields, but without the name assigned to the field by the user, only the internal identifier. If you need the user-defined field name, use " }, { "info": { "name": "Update Existing Custom Contact Field crm.contact.userfield.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.contact.userfield.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.contact.userfield.update` updates an existing custom contact field." }, { "info": { "name": "Add Currency crm.currency.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.currency.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method adds a new currency. For the languages used on the account, localization parameters must be specified. If not provided, [default parameters](../data-types.md#crm_currency_localization) will be used. Localization parameters for a specific language can be set using the [crm.c" }, { "info": { "name": "Get the Symbolic Identifier of the Base Currency crm.currency.base.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.currency.base.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves the symbolic identifier of the base currency. No parameters." }, { "info": { "name": "Set Currency as Base crm.currency.base.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.currency.base.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method changes the base currency. After changing the base currency, it is necessary to update the exchange rates of other currencies relative to the base!" }, { "info": { "name": "Delete Currency crm.currency.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.currency.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes a currency." }, { "info": { "name": "Get Currency Fields crm.currency.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.currency.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves the description of currency fields. Each field is described as a field settings structure [crm_rest_field_description](../data-types.md#crm_rest_field_description). No parameters." }, { "info": { "name": "Get Currency by ID crm.currency.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.currency.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves currency data by its symbolic identifier `id` according to ISO 4217. Localization parameters (settings dependent on language) will be returned for the current account language." }, { "info": { "name": "Get the list of currencies crm.currency.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.currency.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves the list of currencies created on the account. Localization parameters (settings dependent on language) will be returned for the current language of the account." }, { "info": { "name": "Delete currency localizations crm.currency.localizations.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.currency.localizations.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes currency localizations for the specified languages." }, { "info": { "name": "Get Currency Localization Fields crm.currency.localizations.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.currency.localizations.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves the available currency localization fields, which are settings dependent on the language. No parameters." }, { "info": { "name": "Get Currency Localizations crm.currency.localizations.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.currency.localizations.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves existing currency localizations." }, { "info": { "name": "Set Localizations for Currency crm.currency.localizations.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.currency.localizations.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method updates localizations for a currency or adds them if the localization for the specified language does not exist." }, { "info": { "name": "Update Currency crm.currency.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.currency.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method updates an existing currency." }, { "info": { "name": "Create a New Deal crm.deal.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.add](../universal/crm-item-add.md). The method `crm.deal.add` creates a new deal." }, { "info": { "name": "Add Contact to Deal crm.deal.contact.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.contact.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. Some data may be missing here — we will complete it soon. - parameter types are not specified - parameter requirements are not specified" }, { "info": { "name": "Remove Contact from Specified Deal crm.deal.contact.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.contact.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. Some data may be missing here — we will complete it soon. - parameter types are not specified - examples are missing" }, { "info": { "name": "Get Fields for Deal-Contact Connection crm.deal.contact.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.contact.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. Some data may be missing here — we will fill it in shortly. - examples are missing (in other languages) - success response is missing" }, { "info": { "name": "Delete the set of contacts associated with the specified deal crm.deal.contact.items.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.contact.items.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. Some data may be missing — we will complete it shortly. - parameter type is not specified - examples are missing (in other languages)" }, { "info": { "name": "Get a set of contacts associated with a deal crm.deal.contact.items.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.contact.items.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. Some data may be missing — we will complete it shortly. - parameter type is not specified - examples are missing (in other languages)" }, { "info": { "name": "Add Multiple Contacts to a Deal crm.deal.contact.items.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.contact.items.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. Some data may be missing — we will complete it shortly. - parameter types are not specified - parameter requirements are not indicated" }, { "info": { "name": "Delete Deal crm.deal.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.delete](../universal/crm-item-delete.md). The method `crm.deal.delete` removes a deal and all associated objects. Deleting a deal will result in the removal of all related objects, such as CRM activities, history, Tim" }, { "info": { "name": "Set a Common Detail Form for All Users crm.deal.details.configuration.forceCommonScopeForAll", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.details.configuration.forceCommonScopeForAll", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.details.configuration.forceCommonScopeForAll](../../universal/item-details-configuration/crm-item-details-configuration-forceCommonScopeForAll.md). The method `crm.deal.details.configuration.forceCommonScopeForAll`" }, { "info": { "name": "Get Parameters of the Deal Card crm.deal.details.configuration.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.details.configuration.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.details.configuration.get](../../universal/item-details-configuration/crm-item-details-configuration-get.md). The method `crm.deal.details.configuration.get` retrieves the settings of the deal card. It reads the pe" }, { "info": { "name": "Reset Deal Card Settings crm.deal.details.configuration.reset", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.details.configuration.reset", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.details.configuration.reset](../../universal/item-details-configuration/crm-item-details-configuration-reset.md). The method `crm.deal.details.configuration.reset` resets the settings of the deal card. It removes t" }, { "info": { "name": "Set Parameters for the Deal Card crm.deal.details.configuration.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.details.configuration.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.details.configuration.set](../../universal/item-details-configuration/crm-item-details-configuration-set.md). The method `crm.deal.details.configuration.set` sets the settings for the deal card. It records the pers" }, { "info": { "name": "Get Fields of the Deal crm.deal.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.fields](../universal/crm-item-fields.md). The method `crm.deal.fields` returns the description of deal fields, including custom fields. A table with the description of standard fields can be found in the article [Fiel" }, { "info": { "name": "Get Deal by Id crm.deal.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.get](../universal/crm-item-get.md). The method `crm.deal.get` returns a deal by its identifier." }, { "info": { "name": "Get a List of Deals crm.deal.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.item.list](../universal/crm-item-list.md). The method `crm.deal.list` returns a list of deals based on a filter. It is an implementation of the list method for deals." }, { "info": { "name": "Get Deal Products crm.deal.productrows.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.productrows.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.item.productrow.*](../universal/product-rows/index.md). The method `crm.deal.productrows.get` returns the product rows of a deal." }, { "info": { "name": "Set Products in Deal crm.deal.productrows.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.productrows.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.productrow.*](../universal/product-rows/index.md). The method `crm.deal.productrows.set` creates or updates the product rows of a deal. Existing rows that are not passed to the method will be removed from the deal. To" }, { "info": { "name": "Create a Template for Recurring Deal crm.deal.recurring.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.recurring.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.deal.recurring.add` creates a template for a recurring deal based on an existing deal." }, { "info": { "name": "Delete the Recurring Deal Template Setting crm.deal.recurring.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.recurring.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.deal.recurring.delete` removes an existing setting for a recurring deal template. It is suitable when you need to delete the record of a recurring deal template if the associated deal no longer exists. To delete a recurring deal template, you can use the method [crm." }, { "info": { "name": "Create a New Deal from the Template crm.deal.recurring.expose", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.recurring.expose", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.deal.recurring.expose` creates a new deal based on the template for a recurring deal." }, { "info": { "name": "Get the List of Fields for the Recurring Deal Template crm.deal.recurring.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.recurring.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.deal.recurring.fields` returns a description of the fields for the recurring deal template." }, { "info": { "name": "Get Recurring Deal Template Settings by ID crm.deal.recurring.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.recurring.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.deal.recurring.get` returns the fields of the recurring deal template settings by its identifier." }, { "info": { "name": "Get a List of Recurring Deal Template Settings crm.deal.recurring.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.recurring.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.deal.recurring.list` returns a list of recurring deal template settings based on the provided filter." }, { "info": { "name": "Update the Recurring Deal Template Settings crm.deal.recurring.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.recurring.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.deal.recurring.update` updates an existing recurring deal template setting." }, { "info": { "name": "Update Deal crm.deal.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.update](../universal/crm-item-update.md). The method `crm.deal.update` updates an existing deal." }, { "info": { "name": "Create a Custom Field for Deals crm.deal.userfield.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.userfield.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.deal.userfield.add` creates a new custom field for deals." }, { "info": { "name": "Delete Custom Field crm.deal.userfield.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.userfield.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.deal.userfield.delete` removes a custom field from deals." }, { "info": { "name": "Get Custom Deal Field by ID crm.deal.userfield.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.userfield.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.deal.userfield.get` returns a custom deal field by its identifier." }, { "info": { "name": "Get a list of custom fields for deals crm.deal.userfield.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.userfield.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.deal.userfield.list` returns a list of custom fields for deals based on the filter." }, { "info": { "name": "Update Existing Custom Field for Deals crm.deal.userfield.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.deal.userfield.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.deal.userfield.update` updates an existing custom field for deals." }, { "info": { "name": "Create a New Deal Direction crm.dealcategory.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.dealcategory.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.category.add](../../universal/category/crm-category-add.md). This method creates a new deal direction." }, { "info": { "name": "Get Default Deal Category Settings crm.dealcategory.default.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.dealcategory.default.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.category.*](../../universal/category/index.md). This method retrieves the settings for the default deal category. No parameters" }, { "info": { "name": "Set Default Deal Category Settings crm.dealcategory.default.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.dealcategory.default.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.category.*](../../universal/category/index.md). This method records the settings for the default deal category." }, { "info": { "name": "Delete Deal Direction crm.dealcategory.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.dealcategory.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.category.delete](../../universal/category/crm-category-delete.md). This method deletes a deal direction." }, { "info": { "name": "Get Descriptions of Fields for Deal Categories crm.dealcategory.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.dealcategory.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.category.fields](../../universal/category/crm-category-fields.md). This method returns descriptions of fields for deal categories. No parameters required." }, { "info": { "name": "Get Deal Direction crm.dealcategory.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.dealcategory.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.category.get](../../universal/category/crm-category-get.md). This method returns the deal direction by its identifier." }, { "info": { "name": "Filter Deal Categories crm.dealcategory.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.dealcategory.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.category.list](../../universal/category/crm-category-list.md). This method returns a list of deal categories based on the filter. It is an implementation of list methods for deal categories." }, { "info": { "name": "Get a List of Deal Stages for the crm.dealcategory.stage.list Endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.dealcategory.stage.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.category.*](../../universal/category/index.md). This method returns a list of deal stages for the direction specified by the identifier. It is equivalent to calling the [`crm.status.list`](../../status/crm-status-list.m" }, { "info": { "name": "Get the Identifier of the Directory Where Deal Stages are Stored: crm.dealcategory.status", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.dealcategory.status", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.category.*](../../universal/category/index.md). This method returns the identifier of the directory for storing stages based on the deal direction identifier. The identifier is a string of the format `DEAL_STAGE_[Direct" }, { "info": { "name": "Update Deal Direction crm.dealcategory.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.dealcategory.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.category.update](../../universal/category/crm-category-update.md). This method updates an existing deal direction." }, { "info": { "name": "Create a New Document crm.documentgenerator.document.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.document.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.document.add` creates a document based on a template for a CRM entity." }, { "info": { "name": "Delete Document crm.documentgenerator.document.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.document.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.document.delete` removes a document." }, { "info": { "name": "Enable or Disable Public Link for Document crm.documentgenerator.document.enablepublicurl", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.document.enablepublicurl", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.document.enablepublicurl` enables or disables the public link for a document." }, { "info": { "name": "Get Document crm.documentgenerator.document.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.document.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.document.get` returns the document data by its identifier." }, { "info": { "name": "Get Document Fields crm.documentgenerator.document.getfields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.document.getfields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.document.getfields` returns a detail form of the fields of an already created document: which fields are available, their current values, default values, and service indicators." }, { "info": { "name": "Get a List of Documents crm.documentgenerator.document.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.document.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.document.list` returns a list of documents based on the filter." }, { "info": { "name": "Update Document crm.documentgenerator.document.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.document.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.document.update` updates an existing document." }, { "info": { "name": "Upload Document crm.documentgenerator.document.upload", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.document.upload", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.document.upload` uploads a prepared document and attaches it to a CRM entity." }, { "info": { "name": "Add a New Numerator crm.documentgenerator.numerator.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.numerator.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.numerator.add` creates a new numerator." }, { "info": { "name": "Delete crm.documentgenerator.numerator.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.numerator.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.numerator.delete` removes a numerator. You can only delete numerators created through [crm.documentgenerator.numerator.add](./crm-document-generator-numerator-add.md)." }, { "info": { "name": "Get Information About the Numerator crm.documentgenerator.numerator.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.numerator.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.numerator.get` returns information about the numerator by its identifier." }, { "info": { "name": "Get the List of Numerators crm.documentgenerator.numerator.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.numerator.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.numerator.list` returns a list of numerators." }, { "info": { "name": "Update the crm.documentgenerator.numerator.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.numerator.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.numerator.update` updates an existing numerator." }, { "info": { "name": "Add a New Template crm.documentgenerator.template.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.template.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.template.add` adds a new document template." }, { "info": { "name": "Delete Document Template crm.documentgenerator.template.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.template.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.template.delete` removes a document template." }, { "info": { "name": "Get Information About Document Template by Id crm.documentgenerator.template.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.template.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.template.get` returns information about a template by its identifier." }, { "info": { "name": "Get Document Template Fields crm.documentgenerator.template.getfields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.template.getfields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.template.getfields` returns a card of template fields: which fields are available, their current values, default values, and service indicators." }, { "info": { "name": "Get a List of Document Templates crm.documentgenerator.template.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.template.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.template.list` returns a list of document templates." }, { "info": { "name": "Update Existing Document Template crm.documentgenerator.template.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.documentgenerator.template.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.documentgenerator.template.update` updates an existing document template." }, { "info": { "name": "Get leads, contacts, and companies with matching data crm.duplicate.findbycomm", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.duplicate.findbycomm", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.duplicate.findbycomm` returns the identifiers of leads, contacts, and companies that contain phone numbers or email addresses from a specified list. The search does not consider the phone extension." }, { "info": { "name": "Get a List of Fields for Duplicate Search crm.duplicate.volatileType.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.duplicate.volatileType.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.duplicate.volatileType.fields` returns a list of standard and custom fields that can be used for finding duplicates in leads, contacts, and companies." }, { "info": { "name": "Get a List of Custom Fields Used in Duplicate Search crm.duplicate.volatileType.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.duplicate.volatileType.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.duplicate.volatileType.list` returns a list of custom fields that are already being used to search for duplicates in leads, contacts, and companies." }, { "info": { "name": "Add Field to Duplicate Search crm.duplicate.volatileType.register", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.duplicate.volatileType.register", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.duplicate.volatileType.register` adds a field to the duplicate search functionality in leads, contacts, or companies." }, { "info": { "name": "Remove Field from Duplicate Search crm.duplicate.volatileType.unregister", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.duplicate.volatileType.unregister", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.duplicate.volatileType.unregister` removes a custom field from the duplicate search." }, { "info": { "name": "Merge Duplicates crm.entity.mergeBatch", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.entity.mergeBatch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.entity.mergeBatch` merges multiple entities into one." }, { "info": { "name": "Get Activity Direction Enumeration Elements crm.enum.activitydirection", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.enum.activitydirection", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.*](../../../timeline/activities/todo/index.md). The method `crm.enum.activitydirection` returns activity directions for the `DIRECTION` field of [CRM activities related to emails and calls](../../../timelin" }, { "info": { "name": "Get Enumeration Items for \"Activity Notification Type\" crm.enum.activitynotifytype", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.enum.activitynotifytype", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.activity.todo.*](../../../timeline/activities/todo/index.md). The method `crm.enum.activitynotifytype` returns notification types for the `NOTIFY_TYPE` field of [meetings and calls](../../../timeline/activities/index" }, { "info": { "name": "Get Enumeration Items for \"Activity Priorities\" crm.enum.activitypriority", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.enum.activitypriority", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.*](../../../timeline/activities/todo/index.md). The method `crm.enum.activitypriority` returns a list of priorities for the `PRIORITY` field of [activities](../../../timeline/activities/index.md)." }, { "info": { "name": "Get Enumeration Elements \"Status\" crm.enum.activitystatus", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.enum.activitystatus", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.*](../../../timeline/activities/todo/index.md). The method `crm.enum.activitystatus` returns a list of statuses for the `STATUS` field of [deals](../../../timeline/activities/index.md)." }, { "info": { "name": "Get Enumeration Elements \"Activity Types\" crm.enum.activitytype", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.enum.activitytype", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.activity.todo.*](../../../timeline/activities/todo/index.md). The method `crm.enum.activitytype` returns a list of types for the `TYPE_ID` field of [activities](../../../timeline/activities/index.md)." }, { "info": { "name": "Get Address Types crm.enum.addresstype", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.enum.addresstype", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.enum.addresstype` returns a list of address types. Use the `ID` of the address type as the value for the `TYPE_ID` parameter in the methods [crm.address.*](../../requisites/addresses/index.md)." }, { "info": { "name": "Get Enumeration Elements of \"Description Type\" crm.enum.contenttype", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.enum.contenttype", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.activity.todo.*](../../../timeline/activities/todo/index.md). The method `crm.enum.contenttype` returns the description types for the `DESCRIPTION_TYPE` field of [deals](../../../timeline/activities/index.md)." }, { "info": { "name": "Get Fields of CRM Enumeration Elements crm.enum.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.enum.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.enum.fields` returns information about the fields of enumeration elements." }, { "info": { "name": "Get Object Types for Order Binding crm.enum.getorderownertypes", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.enum.getorderownertypes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.enum.getorderownertypes` returns a list of object types to which an order can be bound. Use the `id` of the object type as the value for the `ownerTypeId` parameter in the methods [crm.orderentity.*](../../universal/order-entity/crm-order-entity-add.md). Currently, a" }, { "info": { "name": "Get CRM Object Types crm.enum.ownertype", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.enum.ownertype", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.enum.ownertype` returns the identifiers of CRM object types and SPA. Use the `ID` of the object type as the value for the `entityTypeId` parameter in the methods [crm.item.*](../../universal/index.md), [crm.activity.*](../../timeline/activities/index.md). The identif" }, { "info": { "name": "Get Description of CRM Operation Modes crm.enum.settings.mode", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.enum.settings.mode", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.enum.settings.mode` returns a list of CRM operation modes. Use this method to decode the `ID` value of the type returned by the method [crm.settings.mode.get](../../crm-settings-mode-get.md)." }, { "info": { "name": "Add Invoice crm.invoice.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal methods for invoices](../../universal/invoice.md). This method creates a new invoice. If you need to specify any details of the buyer/seller in the invoice (as there may be multiple for a company), use the method " }, { "info": { "name": "Delete invoice crm.invoice.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal methods for invoices](../../universal/invoice.md). This method deletes an invoice." }, { "info": { "name": "Get Invoice Fields and Associated Products crm.invoice.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [Universal Methods for Invoices](../../universal/invoice.md). This method returns the description of the fields of an [invoice](./crm-invoice-add.md), including [custom fields](./crm-invoice-user-field-add.md). No parameters are" }, { "info": { "name": "Get Invoice by ID crm.invoice.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns an invoice by its ID." }, { "info": { "name": "Get Link to Invoice crm.invoice.getexternallink", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.getexternallink", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns a public link for an online invoice." }, { "info": { "name": "Get a List of Invoices crm.invoice.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns a list of invoices. It is an implementation of the list method for invoices. When querying, use the following masks:" }, { "info": { "name": "Add Configuration for Recurring Invoice crm.invoice.recurring.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.recurring.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method adds a new configuration for a recurring invoice." }, { "info": { "name": "Delete the Recurring Invoice Setting crm.invoice.recurring.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.recurring.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [Universal Methods for Invoices](../../universal/invoice.md). This method deletes an existing setting for the recurring invoice template." }, { "info": { "name": "Create a New Invoice from the Template crm.invoice.recurring.expose", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.recurring.expose", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method creates a new invoice from the recurring invoice template." }, { "info": { "name": "Get Full Template of Recurring Invoice Fields crm.invoice.recurring.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.recurring.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns a list of fields for the recurring invoice template along with their descriptions. No parameters required." }, { "info": { "name": "Get Recurring Invoice Settings by ID crm.invoice.recurring.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.recurring.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns the fields of the recurring invoice template settings by ID." }, { "info": { "name": "Get a List of Recurring Invoice Settings by Filter crm.invoice.recurring.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.recurring.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns a list of recurring invoice template settings based on the specified filter. When querying, use the wildcard \"*\" to select all fields (excludi" }, { "info": { "name": "Change Settings for Recurring Invoice crm.invoice.recurring.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.recurring.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method updates an existing setting for the recurring invoice template." }, { "info": { "name": "Create a New Invoice Status crm.invoice.status.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.status.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [Universal Methods for Invoices](../../universal/invoice.md). The method `crm.invoice.status.add` creates a new invoice status. Starting from version 19.0.0, it is recommended to use the method [crm.status.add](../../../crm/stat" }, { "info": { "name": "Delete Invoice Status crm.invoice.status.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.status.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [Universal Methods for Invoices](../../universal/invoice.md). The method `crm.invoice.status.delete` removes the status of an invoice. Starting from version 19.0.0, it is recommended to use the method [crm.status.delete](../../." }, { "info": { "name": "Get Invoice Status Fields crm.invoice.status.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.status.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [Universal Methods for Invoices](../../universal/invoice.md). The method `crm.invoice.status.fields` returns the description of the invoice status fields. Starting from version 19.0.0, it is recommended to use the method [crm.st" }, { "info": { "name": "Get Invoice Status by ID crm.invoice.status.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.status.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [Universal Methods for Invoices](../../universal/invoice.md). The method `crm.invoice.status.get` returns the status of an invoice based on its ID. Starting from version 19.0.0, it is recommended to use the method [crm.status.ge" }, { "info": { "name": "Get a List of Invoice Statuses crm.invoice.status.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.status.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [Universal Methods for Invoices](../../universal/invoice.md). Starting from version 19.0.0, it is recommended to use the method [crm.status.list](../../../crm/status/crm-status-list.md) The method `crm.invoice.status.list` retur" }, { "info": { "name": "Update Invoice Status crm.invoice.status.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.status.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). The method `crm.invoice.status.update` returns the status of an invoice by its identifier. Starting from version 19.0.0, it is recommended to use the method [crm." }, { "info": { "name": "Update Invoice crm.invoice.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method updates an existing invoice." }, { "info": { "name": "Create a Custom Field for Invoices crm.invoice.userfield.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.userfield.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method creates a new custom field for invoices. There is a system limitation on the field name - 20 characters. The custom field name is always prefixed with" }, { "info": { "name": "Delete Custom Field of Invoices crm.invoice.userfield.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.userfield.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method deletes a custom field of invoices." }, { "info": { "name": "Get User Field by ID crm.invoice.userfield.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.userfield.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns the user field of invoices by its ID." }, { "info": { "name": "Get a List of Custom Fields by Filter crm.invoice.userfield.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.userfield.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns a list of custom fields for invoices based on the specified filter." }, { "info": { "name": "Update Custom Field crm.invoice.userfield.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.invoice.userfield.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method updates an existing custom field for invoices." }, { "info": { "name": "Create a New CRM Entity crm.item.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method is a universal approach for creating objects in CRM. It allows you to create various types of objects, such as deals, contacts, companies, and others. To create an object, you need to pass the appropriate parameters, including the object type and its information: title, des" }, { "info": { "name": "Importing a Batch of CRM Records: crm.item.batchImport", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.batchImport", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This is a universal method for importing objects into CRM. The differences from adding an object are described in more detail [`here`](./index.md). The logic for adding entities is similar to the [crm.item.import](crm-item-import.md) method. A maximum of 20 entities can be imported " }, { "info": { "name": "Delete CRM Item: crm.item.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes a CRM object element by its item ID and entity type ID." }, { "info": { "name": "Get Delivery Information by ID crm.item.delivery.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.delivery.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves brief information about the delivery." }, { "info": { "name": "Get the list of deliveries for a CRM entity crm.item.delivery.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.delivery.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves the list of deliveries for a specific crm entity." }, { "info": { "name": "Set a Common Detail Form for All Users crm.item.details.configuration.forceCommonScopeForAll", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.details.configuration.forceCommonScopeForAll", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.item.details.configuration.forceCommonScopeForAll` enforces a common detail form for all users, removing their personal detail form settings." }, { "info": { "name": "Reset Item Card Parameters crm.item.details.configuration.reset", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.details.configuration.reset", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.item.details.configuration.reset` resets the item card settings to their default values. It removes the personal settings of the specified user or the shared settings defined for all users." }, { "info": { "name": "Set Parameters for crm.item.details.configuration.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.details.configuration.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.item.details.configuration.set` sets the settings for the card of a specific CRM object. It records the personal settings of the specified user or common settings for all users." }, { "info": { "name": "Get Element by Id crm.item.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method returns information about an entity based on its identifier and the identifier of the CRM object type." }, { "info": { "name": "Import One Record crm.item.import", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.import", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. A universal method for importing objects into CRM. You can read about the differences between the import logic and the standard addition of elements in the article [{#T}](./index.md)." }, { "info": { "name": "Get a List of CRM Items: crm.item.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves a list of items of a specific type from the CRM object. CRM object items will not be included in the final selection if the user does not have \"read\" access permission for those items." }, { "info": { "name": "Add Payment crm.item.payment.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.payment.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method creates a payment for a CRM object." }, { "info": { "name": "Delete Payment crm.item.payment.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.payment.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes a payment." }, { "info": { "name": "Add Delivery Item to Payment crm.item.payment.delivery.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.payment.delivery.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method adds a delivery item to the payment." }, { "info": { "name": "Remove Delivery Item from Payment crm.item.payment.delivery.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.payment.delivery.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method removes a delivery item from the payment." }, { "info": { "name": "Get Delivery Item List by Specific Payment crm.item.payment.delivery.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.payment.delivery.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves a list of delivery items for a specific payment." }, { "info": { "name": "Reassign Delivery Position to Another Document crm.item.payment.delivery.setDelivery", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.payment.delivery.setDelivery", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method reassigns a delivery position to another delivery document." }, { "info": { "name": "Get Payment Information crm.item.payment.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.payment.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves brief information about the payment." }, { "info": { "name": "Get the list of payments crm.item.payment.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.payment.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 retrieves a list of payments for a specific CRM object." }, { "info": { "name": "Change Payment Status to \"Paid\" crm.item.payment.pay", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.payment.pay", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method changes the payment status to \"Paid\"." }, { "info": { "name": "Adding a Product Item to Payment crm.item.payment.product.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.payment.product.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method adds a product item to the payment." }, { "info": { "name": "Remove Product Item from Payment crm.item.payment.product.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.payment.product.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method removes a product item from the payment." }, { "info": { "name": "Get a List of Payment Product Items crm.item.payment.product.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.payment.product.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves a list of product items (goods or services) associated with a specific payment." }, { "info": { "name": "Change Product Quantity crm.item.payment.product.setQuantity", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.payment.product.setQuantity", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method changes the quantity of a product in the payment line item." }, { "info": { "name": "Change Payment Status to \"Unpaid\" crm.item.payment.unpay", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.payment.unpay", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method changes the payment status to \"Unpaid\"." }, { "info": { "name": "Update Payment Fields crm.item.payment.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.payment.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method updates a limited set of payment fields (see [`sale.payment.update`](../../../sale/payment/sale-payment-update.md) for extended functionality with payment fields)." }, { "info": { "name": "Add Product Row to CRM Object crm.item.productrow.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.productrow.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method adds a product row to a CRM object." }, { "info": { "name": "Delete product row from CRM object crm.item.productrow.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.productrow.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method removes a product row from the CRM object." }, { "info": { "name": "Get the list of fields for product rows crm.item.productrow.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.productrow.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves the list of fields for product rows. No parameters." }, { "info": { "name": "Get information about a product item by id crm.item.productrow.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.productrow.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves information about a product item in the CRM." }, { "info": { "name": "Get Unpaid Product Rows of CRM Object crm.item.productrow.getAvailableForPayment", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.productrow.getAvailableForPayment", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 retrieves product rows of the CRM object for which the client has not yet been billed." }, { "info": { "name": "Get product rows of the CRM object crm.item.productrow.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.productrow.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 retrieves product rows of the CRM object." }, { "info": { "name": "Save Product Row of CRM Object crm.item.productrow.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.productrow.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method saves the product row of a CRM object. Please note that this method will overwrite all existing product rows associated with the object. Thus, it replaces the existing product rows with those that were sent." }, { "info": { "name": "Update the product row of a CRM object crm.item.productrow.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.item.productrow.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method updates the product row of a CRM object." }, { "info": { "name": "Create a New Lead crm.lead.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.add](../universal/crm-item-add.md). The method `crm.lead.add` creates a new lead." }, { "info": { "name": "Add Contact Binding to Lead crm.lead.contact.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.contact.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method adds a contact binding to the specified lead." }, { "info": { "name": "Remove contact binding from lead crm.lead.contact.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.contact.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method removes the binding of a contact to the specified lead." }, { "info": { "name": "Get Lead-Contact Fields crm.lead.contact.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.contact.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves the description of fields for the lead-contact relationship, used by methods in the `crm.lead.contact.*` family. No parameters." }, { "info": { "name": "Delete Contact List from Lead crm.lead.contact.items.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.contact.items.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes the contact list from a lead." }, { "info": { "name": "Get a List of Related Contacts crm.lead.contact.items.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.contact.items.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves a list of contacts associated with a lead." }, { "info": { "name": "Attach a list of contacts to a lead crm.lead.contact.items.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.contact.items.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method attaches a list of contacts to the specified lead." }, { "info": { "name": "Delete Lead crm.lead.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.item.delete](../universal/crm-item-delete.md). The method `crm.lead.delete` removes a lead and all associated objects: tasks, history, timeline records, and others. Objects are deleted if they are not linked to other objects o" }, { "info": { "name": "Set Common Lead Card for All Users crm.lead.details.configuration.forceCommonScopeForAll", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.details.configuration.forceCommonScopeForAll", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.item.details.configuration.forceCommonScopeForAll](../../universal/item-details-configuration/crm-item-details-configuration-forceCommonScopeForAll.md). The method `crm.lead.details.configuration.forceCommonScopeForAll` for" }, { "info": { "name": "Get Parameters of crm.lead.details.configuration.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.details.configuration.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.details.configuration.get](../../universal/item-details-configuration/crm-item-details-configuration-get.md). The method `crm.lead.details.configuration.get` retrieves the settings for lead cards. The settings for " }, { "info": { "name": "Resetting the Parameters of crm.lead.details.configuration.reset", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.details.configuration.reset", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.details.configuration.reset](../../universal/item-details-configuration/crm-item-details-configuration-reset.md). The method `crm.lead.details.configuration.reset` resets the settings of lead cards. The settings fo" }, { "info": { "name": "Set Parameters for crm.lead.details.configuration.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.details.configuration.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.details.configuration.set](../../universal/item-details-configuration/crm-item-details-configuration-set.md). The method `crm.lead.details.configuration.set` sets the settings for lead cards. The settings for repea" }, { "info": { "name": "Get CRM Lead Fields crm.lead.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.fields](../universal/crm-item-fields.md). The method `crm.lead.fields` returns a description of lead fields, including custom fields. A table with descriptions of standard fields can be found in the article [Fields of" }, { "info": { "name": "Get Lead by Id crm.lead.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.get](../universal/crm-item-get.md). The method `crm.lead.get` returns a lead by its identifier." }, { "info": { "name": "Get a List of Leads crm.lead.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Use [crm.item.list](../universal/crm-item-list.md). The method `crm.lead.list` returns a list of leads based on a filter. It is an implementation of the list method for leads." }, { "info": { "name": "Get Lead Product Rows crm.lead.productrows.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.productrows.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.item.productrow.*](../universal/product-rows/index.md). The method `crm.lead.productrows.get` returns the product rows of a lead." }, { "info": { "name": "Set Products in Lead crm.lead.productrows.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.productrows.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.productrow.*](../universal/product-rows/index.md). The method `crm.lead.productrows.set` creates or updates the product rows of a lead. Existing rows that are not passed to the method will be removed from the lead. To" }, { "info": { "name": "Update Lead crm.lead.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.update](../universal/crm-item-update.md). The method `crm.lead.update` updates an existing lead." }, { "info": { "name": "Create a Custom Field for Leads crm.lead.userfield.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.userfield.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.lead.userfield.add` creates a new custom field for leads." }, { "info": { "name": "Delete Custom Field for Leads crm.lead.userfield.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.userfield.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.lead.userfield.delete` removes a custom field for leads." }, { "info": { "name": "Get Custom Lead Field by ID crm.lead.userfield.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.userfield.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.lead.userfield.get` returns a custom lead field by its identifier." }, { "info": { "name": "Get a List of Custom Fields for Leads crm.lead.userfield.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.userfield.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.lead.userfield.list` returns a list of custom fields for leads based on a filter." }, { "info": { "name": "Update Existing Custom Field for Leads crm.lead.userfield.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.lead.userfield.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.lead.userfield.update` updates an existing custom field for leads." }, { "info": { "name": "Add Measurement Unit crm.measure.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.measure.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.measure.add](../../../catalog/measure/catalog-measure-add.md). This method adds a new measurement unit." }, { "info": { "name": "Delete Measurement Unit crm.measure.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.measure.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.measure.delete](../../../catalog/measure/catalog-measure-delete.md). This method deletes a measurement unit." }, { "info": { "name": "Get Available Fields of crm.measure.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.measure.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.measure.getFields](../../../catalog/measure/catalog-measure-get-fields.md). This method returns a description of the fields for measurement units. No parameters required." }, { "info": { "name": "Get Field Values of Measurement Unit crm.measure.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.measure.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.measure.get](../../../catalog/measure/catalog-measure-get.md). This method returns the values of all fields of a measurement unit by its identifier." }, { "info": { "name": "Get the List of Measurement Units crm.measure.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.measure.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.measure.list](../../../catalog/measure/catalog-measure-list.md). This method returns a list of measurement units. See the description of [list methods](../../../../settings/how-to-call-rest-api/list-methods-peculari" }, { "info": { "name": "Update Measurement Unit crm.measure.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.measure.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.measure.update](../../../catalog/measure/catalog-measure-update.md). This method updates an existing measurement unit." }, { "info": { "name": "Get Description of Multiple Fields crm.multifield.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.multifield.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.multifield.fields` returns the description of multiple fields used to store phone numbers, email addresses, and other contact information in leads, contacts, and companies." }, { "info": { "name": "Add Order Binding to CRM Object crm.orderentity.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.orderentity.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method adds a binding of an order to a CRM object." }, { "info": { "name": "Remove Order Binding to CRM Object crm.orderentity.deleteByFilter", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.orderentity.deleteByFilter", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method removes the binding of an order to a CRM object." }, { "info": { "name": "Get Order Binding Fields crm.orderentity.getFields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.orderentity.getFields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns a list of available order binding fields. Each field is described as a field settings structure [crm_rest_field_description](../../data-types.md#crm_rest_field_description). No parameters." }, { "info": { "name": "Get a list of order bindings to CRM entities crm.orderentity.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.orderentity.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns a list of order bindings to CRM entities." }, { "info": { "name": "Get Fields for Payment Methods crm.paysystem.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.paysystem.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [Universal Methods for Invoices](../../universal/invoice.md). This method returns a description of the fields for payment methods. No parameters required." }, { "info": { "name": "Get a List of Payment Methods crm.paysystem.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.paysystem.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns a list of payment methods applicable to estimates or invoices." }, { "info": { "name": "Get Fields for CRM Payer Types crm.persontype.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.persontype.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [Universal Methods for Invoices](../../universal/invoice.md). This method returns the description of fields for payer types. No parameters required." }, { "info": { "name": "Get a List of CRM Payer Types crm.persontype.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.persontype.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [Universal Methods for Invoices](../../universal/invoice.md). This method returns a list of payer types. For payment systems used in CRM (for invoices, deals), payer types should be retrieved using the `crm.persontype.list` " }, { "info": { "name": "Add Product crm.product.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.product.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.product.add](../../../catalog/product/catalog-product-add.md). The method `crm.product.add` creates a new product." }, { "info": { "name": "Delete Product crm.product.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.product.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [catalog.product.delete](../../../catalog/product/catalog-product-delete.md). The method `crm.product.delete` removes a product." }, { "info": { "name": "Get Product Fields crm.product.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.product.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.product.getFieldsByFilter](../../../catalog/product/catalog-product-get-fields-by-filter.md). The method `crm.product.fields` returns the description of product fields. No parameters required." }, { "info": { "name": "Get Product by ID crm.product.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.product.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.product.get](../../../catalog/product/catalog-product-get.md). The method `crm.product.get` returns a product by its ID." }, { "info": { "name": "Get Product List by Filter crm.product.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.product.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [catalog.product.list](../../../catalog/product/catalog-product-list.md). The method `crm.product.list` returns a list of products based on the filter." }, { "info": { "name": "Add Product Property crm.product.property.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.product.property.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.productProperty.add](../../../catalog/product-property/catalog-product-property-add.md). The method `crm.product.property.add` creates a new product property." }, { "info": { "name": "Delete Product Property crm.product.property.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.product.property.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.productProperty.delete](../../../catalog/product-property/catalog-product-property-delete.md). The method `crm.product.property.delete` removes a product property." }, { "info": { "name": "Get Fields of List-Type Property crm.product.property.enumeration.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.product.property.enumeration.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [catalog.productPropertyEnum.*](../../../catalog/product-property-enum/index.md). The method `crm.product.property.enumeration.fields` returns the description of the fields of a list-type product property. No parameters required" }, { "info": { "name": "Retrieve Product Property Fields crm.product.property.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.product.property.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.productProperty.getFields](../../../catalog/product-property/catalog-product-property-get-fields.md). The method `crm.product.property.fields` returns the description of fields for product properties. No parameters " }, { "info": { "name": "Get Product Property by ID crm.product.property.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.product.property.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.productProperty.get](../../../catalog/product-property/catalog-product-property-get.md). The method `crm.product.property.get` returns the property of products by ID." }, { "info": { "name": "Get a List of Product Properties crm.product.property.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.product.property.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.productProperty.list](../../../catalog/product-property/catalog-product-property-list.md). The method `crm.product.property.list` returns a list of product properties." }, { "info": { "name": "Retrieve Additional Settings Fields for Custom Type crm.product.property.settings.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.product.property.settings.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.productPropertyFeature.*](../../../catalog/product-property-feature/index.md). The method `crm.product.property.settings.fields` returns the description of the additional settings fields for custom type product prop" }, { "info": { "name": "Get a List of Product Property Types crm.product.property.types", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.product.property.types", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.productPropertyFeature.*](../../../catalog/product-property-feature/index.md). The method `crm.product.property.types` returns a list of product property types. No parameters required." }, { "info": { "name": "Update Product Property crm.product.property.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.product.property.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.productProperty.update](../../../catalog/product-property/catalog-product-property-update.md). The method `crm.product.property.update` updates an existing product property." }, { "info": { "name": "Update Product crm.product.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.product.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [catalog.product.update](../../../catalog/product/catalog-product-update.md). The method `crm.product.update` updates an existing product." }, { "info": { "name": "Get Descriptions of Fields for Product Rows crm.productrow.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.productrow.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.productrow.fields](../../universal/product-rows/crm-item-productrow-fields.md). This method retrieves information about the data structure of product rows in the CRM, including field types and their purposes. No pa" }, { "info": { "name": "Get a List of Order Properties crm.productrow.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.productrow.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.productrow.list](../../universal/product-rows/crm-item-productrow-list.md). This method returns a list of product rows based on a filter. It is an implementation of the list method for product rows. The owner of th" }, { "info": { "name": "Add a New Product Section crm.productsection.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.productsection.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [catalog.section.add](../../../catalog/section/catalog-section-add.md). The method `crm.productsection.add` creates a new product section." }, { "info": { "name": "Delete Product Section crm.productsection.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.productsection.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.section.delete](../../../catalog/section/catalog-section-delete.md). The method `crm.productsection.delete` removes a product category from the catalog." }, { "info": { "name": "Get Fields of the Product Section crm.productsection.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.productsection.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.section.getFields](../../../catalog/section/catalog-section-get-fields.md). The method `crm.productsection.fields` returns the description of the [fields of the section](./crm-product-section-add.md) for the product" }, { "info": { "name": "Get Product Section by ID crm.productsection.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.productsection.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [catalog.section.get](../../../catalog/section/catalog-section-get.md). The method `crm.productsection.get` [returns the product section](./crm-product-section-add.md) by its ID." }, { "info": { "name": "Get a List of Sections from crm.productsection.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.productsection.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.section.list](../../../catalog/section/catalog-section-list.md). The method `crm.productsection.list` returns a list of product sections based on a filter. It is an implementation of the list method for product sect" }, { "info": { "name": "Update Product Section crm.productsection.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.productsection.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [catalog.section.update](../../../catalog/section/catalog-section-update.md). The method `crm.productsection.update` updates an existing product section." }, { "info": { "name": "Add Estimate crm.quote.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.quote.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.add](../universal/crm-item-add.md). The method `crm.quote.add` creates an estimate. If you need to explicitly specify the details of the buyer and seller in the estimate, use the method [crm.requisite.link.register](." }, { "info": { "name": "Delete Estimate crm.quote.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.quote.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.delete](../universal/crm-item-delete.md). The method `crm.quote.delete` removes an estimate." }, { "info": { "name": "Get Fields of the Estimate crm.quote.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.quote.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.item.fields](../universal/crm-item-fields.md). The method `crm.quote.fields` returns a description of the fields of the estimate, including custom fields." }, { "info": { "name": "Get Estimate by ID: crm.quote.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.quote.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.get](../universal/crm-item-get.md). The method `crm.quote.get` returns an estimate by its ID." }, { "info": { "name": "Get a List of Estimates by Filter crm.quote.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.quote.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.item.list](../universal/crm-item-list.md). The method `crm.quote.list` returns a list of estimates based on a filter. This method implements the [list method](../../../settings/how-to-call-rest-api/list-methods-pecularities.md" }, { "info": { "name": "Retrieve Product Rows of the Estimate crm.quote.productrows.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.quote.productrows.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.productrow.*](../universal/product-rows/index.md). The method `crm.quote.productrows.get` returns the product rows of an estimate." }, { "info": { "name": "Set Product Rows for the Quote crm.quote.productrows.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.quote.productrows.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.productrow.*](../universal/product-rows/index.md). The method `crm.quote.productrows.set` creates or updates product rows in an estimate. To modify only a single row, use the methods [crm.item.productrow.*](../univers" }, { "info": { "name": "Update Estimate crm.quote.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.quote.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [crm.item.update](../universal/crm-item-update.md). The method `crm.quote.update` updates an existing estimate." }, { "info": { "name": "Create a Custom Field for Estimates crm.quote.userfield.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.quote.userfield.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.quote.userfield.add` creates a new custom field for estimates." }, { "info": { "name": "Delete Custom Field for Quotes crm.quote.userfield.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.quote.userfield.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.quote.userfield.delete` removes a custom field from quotes." }, { "info": { "name": "Get Custom Field of Estimates by ID crm.quote.userfield.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.quote.userfield.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.quote.userfield.get` returns a custom field of estimates by its identifier." }, { "info": { "name": "Get a List of Custom Fields for crm.quote.userfield.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.quote.userfield.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.quote.userfield.list` returns a list of custom fields for estimates based on a filter." }, { "info": { "name": "Update Existing Custom Field for Quotes crm.quote.userfield.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.quote.userfield.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.quote.userfield.update` updates an existing custom field for quotes." }, { "info": { "name": "Add Requisite crm.requisite.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method adds a new requisite." }, { "info": { "name": "Create a new bank detail crm.requisite.bankdetail.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.bankdetail.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method creates a new bank detail." }, { "info": { "name": "Delete bank detail crm.requisite.bankdetail.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.bankdetail.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes a bank detail." }, { "info": { "name": "Get Description of Bank Details Fields crm.requisite.bankdetail.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.bankdetail.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns a formal description of the bank details fields. No parameters." }, { "info": { "name": "Get bank details by id crm.requisite.bankdetail.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.bankdetail.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns bank details by identifier." }, { "info": { "name": "Get a list of bank details by filter crm.requisite.bankdetail.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.bankdetail.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns a list of bank details based on the filter." }, { "info": { "name": "Update Bank Details crm.requisite.bankdetail.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.bankdetail.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method updates an existing bank detail." }, { "info": { "name": "Delete Requisite and Related Objects crm.requisite.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes a requisite and all associated objects (links to other entities, addresses, bank details)." }, { "info": { "name": "Get Requisite by ID crm.requisite.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves the requisite by its identifier `id`." }, { "info": { "name": "Get the link of the requisite with the object crm.requisite.link.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.link.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns the link of the requisites with the object." }, { "info": { "name": "Get a list of links for requisites crm.requisite.link.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.link.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns a list of links for requisites based on the filter." }, { "info": { "name": "Register Requisite Link with Object crm.requisite.link.register", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.link.register", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method registers a link between requisites and an object. For successful registration, the requisite IDs must belong to the client and seller selected in the linked object. If a requisite is not available, its ID is passed as `0`. You can even specify all requisite IDs as zero." }, { "info": { "name": "Unlink Requisite from Object crm.requisite.link.unregister", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.link.unregister", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method removes the link between requisites and the object." }, { "info": { "name": "Get a List of Requisites by Filter crm.requisite.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves a list of requisites based on a filter." }, { "info": { "name": "Create a Template crm.requisite.preset.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.preset.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method creates a new requisites template." }, { "info": { "name": "Get a list of countries for the template crm.requisite.preset.countries", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.preset.countries", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns a possible list of countries for [requisite templates](./index.md). Country identifiers are used as values for the `COUNTRY_ID` field of the template. No parameters required." }, { "info": { "name": "Delete the CRM Requisite Template crm.requisite.preset.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.preset.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes a requisite template by its identifier." }, { "info": { "name": "Add a Custom Field to the CRM Requisite Template crm.requisite.preset.field.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.preset.field.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method adds a custom field to the requisite template. You can use the method [crm.requisite.preset.field.availabletoadd](./crm-requisite-preset-field-available-to-add.md) to retrieve the fields available for addition to the template. Before adding a user-defined field `UF_.." }, { "info": { "name": "Get Fields Available for Addition to the Requisite Template crm.requisite.preset.field.availabletoadd", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.preset.field.availabletoadd", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns fields available for addition to the specified requisite template." }, { "info": { "name": "Delete Custom Field from CRM Requisite Template crm.requisite.preset.field.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.preset.field.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes a custom field from the requisite template." }, { "info": { "name": "Get Description of Custom Fields for the Requisite Template crm.requisite.preset.field.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.preset.field.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method returns a formal description of the fields that describe the customizable field of the requisite template. No parameters." }, { "info": { "name": "Get Custom Field of Requisite Template by ID crm.requisite.preset.field.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.preset.field.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns the description of the custom field of the requisite template by its identifier." }, { "info": { "name": "Get a list of all customizable fields for a specified CRM requisites template crm.requisite.preset.field.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.preset.field.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns a list of all customizable fields for a specific requisites template." }, { "info": { "name": "Update Custom Field of a Given Requisite Template crm.requisite.preset.field.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.preset.field.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method updates a custom field in the requisite template." }, { "info": { "name": "Get Description of the Fields of the Requisite Template crm.requisite.preset.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.preset.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns a formal description of the fields of the requisite template. No parameters." }, { "info": { "name": "Get Requisite Template Fields by ID crm.requisite.preset.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.preset.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method returns the requisite template by its identifier." }, { "info": { "name": "Get a list of requisites templates by filter crm.requisite.preset.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.preset.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns a list of requisites templates based on the filter." }, { "info": { "name": "Update Requisite Template crm.requisite.preset.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.preset.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method updates the requisite template." }, { "info": { "name": "Update Requisite crm.requisite.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method updates an existing requisite." }, { "info": { "name": "Create a New Custom Field for crm.requisite.userfield.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.userfield.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method creates a new custom field for the requisite. The system limitation for the field name is 20 characters. The custom field name always has the prefix `UF_CRM_`, meaning the actual length of the name is 13 characters." }, { "info": { "name": "Delete User Field of Requisite crm.requisite.userfield.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.userfield.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes a user field of the requisite." }, { "info": { "name": "Get User Field by ID crm.requisite.userfield.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.userfield.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns the user field of the requisite by its identifier." }, { "info": { "name": "Get a list of custom fields of the requisite by filter crm.requisite.userfield.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.requisite.userfield.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns a list of custom fields of the requisite based on the filter." }, { "info": { "name": "Determine the Current CRM Operating Mode crm.settings.mode.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.settings.mode.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns the current settings of the CRM operating mode: **classic CRM mode** (with leads) or **simple CRM mode** (without leads). This mode affects a number of CRM operation scenarios, and for better understanding, we recommend reading the [relevant article](https://helpdesk.bi" }, { "info": { "name": "Get Stage History with crm.stagehistory.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.stagehistory.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.stagehistory.list` returns records of stage movement history for the following elements: - [leads](./leads/index.md), - [deals](./deals/index.md)," }, { "info": { "name": "Create CRM Status Element crm.status.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.status.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.status.add` creates a new element in the specified CRM directory: deal stage, source, company type, and others." }, { "info": { "name": "Delete CRM Status Element crm.status.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.status.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.status.delete` removes a status element by its identifier." }, { "info": { "name": "Get directory items by type crm.status.entity.items", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.status.entity.items", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.status.entity.items` returns all directory items by the identifier `ENTITY_ID`, sorted by the `SORT` field. This method is similar to [crm.status.list](crm-status-list.md), except that the latter allows you to define sorting rules." }, { "info": { "name": "Get a directory item by ID crm.status.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.status.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.status.get` returns the parameters of a directory item by its ID." }, { "info": { "name": "Get a List of Directory Items by Filter crm.status.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.status.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.status.list` returns a list of directory items based on the filter." }, { "info": { "name": "Update CRM Status Element crm.status.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.status.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.status.update` updates the parameters of an existing CRM status element." }, { "info": { "name": "Add Timeline Record Binding to CRM Entity crm.timeline.bindings.bind", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.bindings.bind", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method adds a binding of a timeline record to a CRM entity." }, { "info": { "name": "Get CRM entity bindings fields and timeline record in crm.timeline.bindings.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.bindings.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves a list of available fields for linking CRM entities and timeline records. No parameters." }, { "info": { "name": "Get the list of bindings for a record in the timeline crm.timeline.bindings.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.bindings.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 retrieves a list of bindings for a record in the timeline." }, { "info": { "name": "Unbind Timeline Record from CRM Entity crm.timeline.bindings.unbind", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.bindings.unbind", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method removes the binding of a timeline record from a CRM entity." }, { "info": { "name": "Add Comment crm.timeline.comment.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.comment.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method adds a new activity of type \"Comment\" to the timeline." }, { "info": { "name": "Delete Comment crm.timeline.comment.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.comment.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes a \"Comment\" type deal." }, { "info": { "name": "Get Fields of crm.timeline.comment.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.comment.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves the fields of a \"Comment\" type deal. No parameters required." }, { "info": { "name": "Get Information About the Comment crm.timeline.comment.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.comment.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves information about a comment type deal." }, { "info": { "name": "Get a List of Comments from crm.timeline.comment.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.comment.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.timeline.comment.list` retrieves a list of all comments associated with a specified CRM entity." }, { "info": { "name": "Update Comment crm.timeline.comment.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.comment.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method updates a \"Comment\" type deal in the timeline." }, { "info": { "name": "Add Icon to crm.timeline.icon.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.icon.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method adds a new icon." }, { "info": { "name": "Delete Icon crm.timeline.icon.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.icon.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes an icon." }, { "info": { "name": "Get Information About the crm.timeline.icon.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.icon.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves information about the timeline log entry icon." }, { "info": { "name": "Get a List of Available Icons crm.timeline.icon.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.icon.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves a list of available icons for timeline log entries. No parameters." }, { "info": { "name": "Pinning an Item in the Timeline crm.timeline.item.pin", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.item.pin", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.timeline.item.pin` pins an item in the timeline." }, { "info": { "name": "Unpin Timeline Item in crm.timeline.item.unpin", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.item.unpin", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.timeline.item.unpin` unpins a timeline item." }, { "info": { "name": "Delete a Set of Additional Content Blocks for the Timeline Record crm.timeline.layout.blocks.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.layout.blocks.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.timeline.layout.blocks.delete` removes a set of additional content blocks for a timeline record. Within the application, you can only delete the set of additional content blocks that was installed through this application." }, { "info": { "name": "Retrieve a Set of Additional Content Blocks for the Timeline Record crm.timeline.layout.blocks.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.layout.blocks.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.timeline.layout.blocks.get` retrieves a set of additional content blocks for a timeline record. Within the application, you can only obtain the set of additional content blocks that has been established through this application." }, { "info": { "name": "Set a Set of Additional Content Blocks in the CRM Timeline Record: crm.timeline.layout.blocks.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.layout.blocks.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.timeline.layout.blocks.set` sets a set of additional content blocks for a timeline record. Setting a new set of additional content blocks in a timeline record will overwrite any previously added set within the same application. The setting of additional content block" }, { "info": { "name": "Add Log Entry crm.timeline.logmessage.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.logmessage.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method adds a new log entry to the timeline." }, { "info": { "name": "Delete log entry crm.timeline.logmessage.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.logmessage.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes a timeline log entry. You can only delete a log entry in the context of the [application](https://dev.quickbooks.com/docs/chm_files/app.zip) that created it. This means that only the application that added the entry can delete it. This ensures data security and c" }, { "info": { "name": "Get Information About the Log Entry crm.timeline.logmessage.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.logmessage.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves information about a timeline log entry. It is important to note that the method can only retrieve data about entries that were previously added using [`crm.timeline.logmessage.add`](./crm-timeline-logmessage-add.md). System entries cannot be retrieved using `cr" }, { "info": { "name": "Get a List of Timeline Log Entries crm.timeline.logmessage.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.logmessage.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves a list of timeline log entries. It is important to note that the method can only retrieve data for entries that were previously added using [`crm.timeline.logmessage.add`](./crm-timeline-logmessage-add.md). System entries cannot be retrieved using `crm.timeline" }, { "info": { "name": "Add Logo crm.timeline.logo.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.logo.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method adds a new logo." }, { "info": { "name": "Delete logo crm.timeline.logo.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.logo.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes the logo." }, { "info": { "name": "Get Information About the Logo crm.timeline.logo.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.logo.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves information about the logo of the timeline log entry." }, { "info": { "name": "Get a list of available logos crm.timeline.logo.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.logo.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves a list of available logos for timeline log entries. No parameters." }, { "info": { "name": "Delete Note crm.timeline.note.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.note.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes a timeline note." }, { "info": { "name": "Get Information About the Note crm.timeline.note.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.note.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 returns information about a note related to a timeline record." }, { "info": { "name": "Save Note crm.timeline.note.save", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.timeline.note.save", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method allows you to save a note." }, { "info": { "name": "Create a Sales Intelligence Trace: crm.tracking.trace.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.tracking.trace.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.tracking.trace.add` creates a Sales Intelligence trace and returns its identifier." }, { "info": { "name": "Delete Sales Intelligence Trace crm.tracking.trace.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.tracking.trace.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.tracking.trace.delete` removes a Sales Intelligence trace." }, { "info": { "name": "Create a new custom type crm.type.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.type.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method creates a new SPA." }, { "info": { "name": "Delete user type crm.type.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.type.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes an existing smart process by the identifier `id`. You can only delete a smart process if there are no associated elements. If such elements exist, they must be deleted first before deleting the smart process." }, { "info": { "name": "Get Custom Type Fields crm.type.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.type.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves information about the custom fields of the smart process settings. No parameters." }, { "info": { "name": "Get the user type by id crm.type.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.type.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 retrieves information about the SPA with the identifier `id`." }, { "info": { "name": "Get the user type by entityTypeId crm.type.getByEntityTypeId", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.type.getByEntityTypeId", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 retrieves information about the SPA with the smart process type identifier `entityTypeId`." }, { "info": { "name": "Get a list of custom types crm.type.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.type.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method retrieves a list of smart process settings." }, { "info": { "name": "Update User Type crm.type.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.type.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method updates an existing SPA by its identifier `id`." }, { "info": { "name": "Get Field Descriptions for Custom Field Type \"Enumeration\" (List) crm.userfield.enumeration.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.userfield.enumeration.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.userfield.enumeration.fields` returns field descriptions for a custom field of type \"enumeration\" (list)." }, { "info": { "name": "Get Description for Custom Fields crm.userfield.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.userfield.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.userfield.fields` returns a description of the characteristics of custom fields." }, { "info": { "name": "Get Field Settings Description for Custom Field Type crm.userfield.settings.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.userfield.settings.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.userfield.settings.fields` returns the field settings description for the specified custom field type." }, { "info": { "name": "Get a list of custom field types crm.userfield.types", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.userfield.types", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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.userfield.types` retrieves the available types of custom fields. The types returned are: - `string` — string" }, { "info": { "name": "Create VAT Rate crm.vat.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.vat.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [catalog.vat.add](../../../catalog/vat/catalog-vat-add.md). The method `crm.vat.add` creates a new VAT rate in the CRM." }, { "info": { "name": "Delete VAT Rate crm.vat.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.vat.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been discontinued. Please use [catalog.vat.delete](../../../catalog/vat/catalog-vat-delete.md). The method `crm.vat.delete` removes a VAT rate by its identifier." }, { "info": { "name": "Get VAT Rate Fields crm.vat.fields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.vat.fields", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [catalog.vat.getFields](../../../catalog/vat/catalog-vat-get-fields.md). The method `crm.vat.fields` returns a description of the VAT rate fields." }, { "info": { "name": "Get VAT Rate by ID crm.vat.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.vat.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 [catalog.vat.get](../../../catalog/vat/catalog-vat-get.md). The method `crm.vat.get` returns the parameters of the VAT rate by its ID." }, { "info": { "name": "Get a List of VAT Rates by Filter crm.vat.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.vat.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.vat.list](../../../catalog/vat/catalog-vat-list.md). The method `crm.vat.list` returns a list of VAT rates based on a filter. It is an implementation of the [list method](../../../../settings/how-to-call-rest-api/li" }, { "info": { "name": "Update Existing VAT Rate crm.vat.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/crm.vat.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 development of this method has been halted. Please use [catalog.vat.update](../../../catalog/vat/catalog-vat-update.md). The method `crm.vat.update` updates the parameters of an existing VAT rate." }, { "info": { "name": "Delete Trigger ctrigger.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/ctrigger.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method deletes a trigger. The method can only be executed in the application context." }, { "info": { "name": "Generate a Link for a Specific Payment salescenter.payment.getPublicUrl", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/salescenter.payment.getPublicUrl", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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. This method generates a link for a specific payment. The payment method selected will be passed to this particular payment." }, { "info": { "name": "Add Custom Field userfieldconfig.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/userfieldconfig.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 `userfieldconfig.add` method adds a new custom field." }, { "info": { "name": "Delete User Field userfieldconfig.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/userfieldconfig.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 `userfieldconfig.delete` method removes a user field." }, { "info": { "name": "Get User Field Settings userfieldconfig.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/userfieldconfig.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 `userfieldconfig.get` method returns the settings of a user field by its identifier." }, { "info": { "name": "Get Available User Field Types userfieldconfig.getTypes", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/userfieldconfig.getTypes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so the assistant can utilize the official REST documentation. The method `userfieldconfig.getTypes` returns a set of available user field types for the module." }, { "info": { "name": "Get a List of User Field Settings userfieldconfig.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/userfieldconfig.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 `userfieldconfig.list` returns a list of user field settings based on the filter." }, { "info": { "name": "Update User Field userfieldconfig.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/userfieldconfig.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "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 `userfieldconfig.update` method updates the settings of an existing user field." } ] } ], "bundled": true }