{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bitrix24 REST BIconnector Widgets API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "auth",
      "value": "{{auth}}",
      "placement": "query"
    }
  },
  "items": [
    {
      "info": {
        "name": "Widgets",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Set Up an Event Handler for the Interface BX24.placement.bindEvent",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/BX24.placement.bindEvent",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (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 `BX24.placement.bindEvent` sets an event handler for the interface. The event must be registered on the calling side; otherwise, nothing will happen."
        },
        {
          "info": {
            "name": "Call the Registered Interface Command BX24.placement.call",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/BX24.placement.call",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (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 `BX24.placement.call` invokes a registered interface command."
        },
        {
          "info": {
            "name": "Get Information About the JS Interface of the Current Placement BX24.placement.getInterface",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/BX24.placement.getInterface",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (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 `BX24.placement.getInterface` allows you to retrieve information about the JS interface of the current placement: a list of available commands and events."
        },
        {
          "info": {
            "name": "Get Information About the Call Context of BX24.placement.info",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/BX24.placement.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 `BX24.placement.info` retrieves information about the context of the embedding handler call. No parameters."
        },
        {
          "info": {
            "name": "Set Up the Widget Handler placement.bind",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/placement.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. The method `placement.bind` adds a handler for the widget placement. It can be called at any time during the application's operation; however, it is often more convenient to register your widgets during the [application installation](../../settings/app-installation/index.md). It is import"
        },
        {
          "info": {
            "name": "Get a List of Registered Placement Handlers placement.get",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/placement.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 `placement.get` retrieves a list of registered widget placement handlers."
        },
        {
          "info": {
            "name": "Get a List of Available Application Embed Locations placement.list",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/placement.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 `placement.list` returns a list of available embed locations for the application. The method works only in the context of the [application](../../settings/app-installation/index.md)."
        },
        {
          "info": {
            "name": "Remove Registered Automation Rule Handler placement.unbind",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/placement.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. The method `placement.unbind` removes the registered Automation rule handler. The method works only in the context of the [application](../../settings/app-installation/index.md)."
        },
        {
          "info": {
            "name": "Register a New User Field Type userfieldtype.add",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/userfieldtype.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 `userfieldtype.add` registers a new type of user fields. After registering the type, create a user field using the [userfieldconfig.add](../../crm/universal/userfieldconfig/userfieldconfig-add.md) method. When opening a card with a user type field, an array `PLACEMENT_OPTION"
        },
        {
          "info": {
            "name": "Delete Registered User Field Type userfieldtype.delete",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/userfieldtype.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 `userfieldtype.delete` removes a user field type registered by the application. It returns _true_ or an error with a description of the reason."
        },
        {
          "info": {
            "name": "Get a list of registered user field types userfieldtype.list",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/userfieldtype.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 user field types registered by the application. It returns a list of field types with pagination. No parameters."
        },
        {
          "info": {
            "name": "Change settings for user field type userfieldtype.update",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/userfieldtype.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 `userfieldtype.update` modifies the settings of a user field type registered by the application. It returns _true_ or an error with a description of the reason."
        }
      ]
    }
  ],
  "bundled": true
}