{ "opencollection": "1.0.0", "info": { "name": "Bitrix24 REST BIconnector Document Generator API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "items": [ { "info": { "name": "Document Generator", "type": "folder" }, "items": [ { "info": { "name": "Create a New Document Based on a Template documentgenerator.document.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.document.add` creates a new document based on a template." }, { "info": { "name": "Delete document documentgenerator.document.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.document.delete` removes a document by its identifier." }, { "info": { "name": "Enable or disable public link for document documentgenerator.document.enablepublicurl", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.document.enablepublicurl` enables or disables the public link for a document." }, { "info": { "name": "Get Document by ID documentgenerator.document.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.document.get` returns information about a document by its ID." }, { "info": { "name": "Get the list of fields for the document documentgenerator.document.getfields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.document.getfields` returns the fields of the document, along with their current and base values." }, { "info": { "name": "Get the List of Documents documentgenerator.document.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.document.list` returns a list of documents based on the filter." }, { "info": { "name": "Update Existing Document documentgenerator.document.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.document.update` updates a document with new field values." }, { "info": { "name": "Add Document Generator Numerator: documentgenerator.numerator.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.numerator.add` creates a document numerator." }, { "info": { "name": "Delete the documentgenerator.numerator.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.numerator.delete` removes a numerator by its identifier. You can only delete a numerator that was created using the `documentgenerator.numerator.add` method." }, { "info": { "name": "Get Numerator by ID documentgenerator.numerator.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.numerator.get` returns the numerator data by its ID." }, { "info": { "name": "Get the List of Numerators documentgenerator.numerator.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.numerator.list` returns a list of numerators for the document generator. It retrieves all numerators available in the current Bitrix24, including [CRM numerators](../../crm/document-generator/numerator/index.md)." }, { "info": { "name": "Update the documentgenerator.numerator.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.numerator.update` updates the numerator by its identifier. You can only update a numerator that was created through the REST method `documentgenerator.numerator.add`." }, { "info": { "name": "Add Region documentgenerator.region.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/documentgenerator.region.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 `documentgenerator.region.add` adds a new custom region." }, { "info": { "name": "Delete Region documentgenerator.region.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/documentgenerator.region.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 `documentgenerator.region.delete` removes a custom region by its identifier." }, { "info": { "name": "Get Region by ID documentgenerator.region.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/documentgenerator.region.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 `documentgenerator.region.get` returns region data based on the identifier or code." }, { "info": { "name": "Get the List of Regions documentgenerator.region.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/documentgenerator.region.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 `documentgenerator.region.list` returns a list of pre-installed and custom regions." }, { "info": { "name": "Update Region documentgenerator.region.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/documentgenerator.region.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 `documentgenerator.region.update` updates a user-defined region by its identifier." }, { "info": { "name": "Add Role documentgenerator.role.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/documentgenerator.role.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 `documentgenerator.role.add` adds a new role." }, { "info": { "name": "Delete Role documentgenerator.role.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/documentgenerator.role.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 `documentgenerator.role.delete` removes a role by its identifier." }, { "info": { "name": "Bind Users to Roles documentgenerator.role.fillaccesses", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/documentgenerator.role.fillaccesses", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (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 `documentgenerator.role.fillaccesses` completely overwrites the mapping of roles to access codes. The method fully overwrites the settings." }, { "info": { "name": "Get Role by ID documentgenerator.role.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/documentgenerator.role.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 `documentgenerator.role.get` returns information about the role and its access permissions." }, { "info": { "name": "Get a List of Roles documentgenerator.role.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/documentgenerator.role.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 `documentgenerator.role.list` returns a list of roles without detailing permissions." }, { "info": { "name": "Change Role documentgenerator.role.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/documentgenerator.role.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 `documentgenerator.role.update` updates a role by its identifier." }, { "info": { "name": "Upload Template documentgenerator.template.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.template.add` adds a new document template." }, { "info": { "name": "Delete Template documentgenerator.template.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.template.delete` removes a template. 1. If there are documents in the system associated with the specified template, the template is marked as deleted to preserve the document associations. You can retrieve a list of templates marked as deleted using the m" }, { "info": { "name": "Get Template by ID documentgenerator.template.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.template.get` returns information about a template by its ID." }, { "info": { "name": "Get the List of Fields for documentgenerator.template.getfields", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.template.getfields` returns the detail form of the template fields." }, { "info": { "name": "Get a List of documentgenerator.template.list Templates", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.template.list` returns a list of templates based on the filter." }, { "info": { "name": "Update Template documentgenerator.template.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/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 `documentgenerator.template.update` updates an existing template." } ] } ], "bundled": true }