{ "opencollection": "1.0.0", "info": { "name": "Bitrix24 REST BIconnector General Methods API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "items": [ { "info": { "name": "General Methods", "type": "folder" }, "items": [ { "info": { "name": "Get Access Permission Names access.name", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/access.name", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (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 `access.name` retrieves the names of access permissions." }, { "info": { "name": "Show information about the app app.info", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/app.info", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (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 `app.info` returns information about the application. No parameters." }, { "info": { "name": "Get Application-Linked Data app.option.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/app.option.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 `app.option.get` retrieves data linked to the application. If no input is provided, it will return all properties recorded via [app.option.set](./app-option-set.md)." }, { "info": { "name": "Bind Data to the app.option.set Method", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/app.option.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 `app.option.set` method binds data to the application." }, { "info": { "name": "Get information about feature availability on the account feature.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/feature.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 `feature.get` returns information about the availability of features on a specific account." }, { "info": { "name": "Get a list of available methods method.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/method.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.get` method returns two parameters `isExisting` and `isAvailable`, which determine the existence of the method on the account and its availability for invocation." }, { "info": { "name": "Get a List of Available Methods", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/methods", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `methods` method retrieves a list of available methods. Development of this method has been halted. Please use [method.get](./method-get.md)." }, { "info": { "name": "Get Basic Information About the Current User Profile", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/profile", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `profile` method allows you to retrieve basic information about the current user without any scopes, unlike [user.current](../../user/user-current.md). No parameters required." }, { "info": { "name": "Get a List of Available Permissions Scope", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/scope", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `scope` method returns a list of permissions." }, { "info": { "name": "Get Current Server Time server.time", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/server.time", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (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 `server.time` returns the current server time in the format `YYYY-MM-DDThh:mm:ss±hh:mm`. No parameters." }, { "info": { "name": "Determine the user.access permissions set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/user.access", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `user.access` method checks if the current user has at least one of the permissions specified in the `ACCESS` parameter." }, { "info": { "name": "Determine Access Permissions for Application Settings user.admin", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/user.admin", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (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 `user.admin` determines whether the current user has the permissions to manage application settings. No parameters." }, { "info": { "name": "Get data associated with the application and user user.option.*", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/user.option", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "Some data may be missing — we will complete it soon. - missing parameters or fields - parameter types not specified - required parameters not specified" }, { "info": { "name": "Get User Data Associated with the Application user.option.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/user.option.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 `user.option.get` retrieves user data associated with the application. If no input is provided, it will return all properties recorded through [user.option.set](./user-option-set.md)." }, { "info": { "name": "Bind Data to User and Application user.option.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/user.option.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 `user.option.set` binds data to the application and user. The application can be bound to the user who installed it if it is a [headless application](../../../local-integrations/serverside-local-app-with-no-ui.md) or to the user with whom it interacts if it is a [UI applicat" } ] } ], "bundled": true }