{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bitrix24 REST BIconnector Users API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "auth",
      "value": "{{auth}}",
      "placement": "query"
    }
  },
  "items": [
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Information About the Current User user.current",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/user.current",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (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.current` retrieves information about the [current](*current_key*) user. The list of user fields in Bitrix24 that will be obtained as a result of executing the method depends on the application's/webhook's scope. Details about user data access can be found in the [article]"
        },
        {
          "info": {
            "name": "Get User Fields user.fields",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/user.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 `user.fields` method allows you to retrieve a list of user field names. The method returns a standard list of fields, and the use of custom fields is not supported. The list of user fields in Bitrix24 that will be obtained as a result of executing the method depends on the application"
        },
        {
          "info": {
            "name": "Get a List of Users with Search by Personal Data user.search",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/user.search",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "auth",
              "value": "{{auth}}",
              "placement": "query"
            }
          },
          "docs": "If you are developing integrations for Bitrix24 using AI tools (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.search` method allows you to retrieve a list of users with accelerated search based on personal data (first name, last name, patronymic, department name, job title). It operates in two modes: quickly using **Fulltext Index** and a slower option through [right LIKE](*key_right LI"
        },
        {
          "info": {
            "name": "Add Custom Field user.userfield.add",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/user.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 `user.userfield.add` adds a custom field."
        },
        {
          "info": {
            "name": "Delete User Field user.userfield.delete",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/user.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 `user.userfield.delete` removes a user field."
        },
        {
          "info": {
            "name": "Get File from User Field user.userfield.file.get",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/user.userfield.file.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 page is hidden from the menu, and the method is not operational. Some data may be missing here — we will complete it shortly. - It may be necessary to list parameters or fields in a table."
        },
        {
          "info": {
            "name": "Get a list of custom fields user.userfield.list",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/user.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 `user.userfield.list` retrieves a list of custom fields based on the filter."
        },
        {
          "info": {
            "name": "Update User Field user.userfield.update",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{portal}.bitrix24.com/rest/user.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 `user.userfield.update` updates a user field."
        }
      ]
    }
  ],
  "bundled": true
}