Application Settings: Overview of Methods

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Application settings store general integration parameters and personal values for each user.

Quick navigation: all methods

The methods in this section work only in the context of the application.

How to Choose a Group of Methods

If the setting is the same for the entire application, use the method group app.option.*. This is suitable for general integration parameters that do not depend on the user.

If each user should have their own values, use the method group user.option.*. For example, for personal interface settings or operational parameters.

Considerations Before Calling Methods

Access Permissions. The method app.option.set is available only to administrators. The methods for reading settings and user.option.* are available to any user in the context of the application.

User Binding. The methods user.option.set and user.option.get save and read not the general application settings, but the settings of a specific user. Use them when different users should have different values, such as for personal interface settings.

Relationships with Other Objects

Application. The group of methods System Methods checks the application context, available scopes, and the presence of the method on the account. For example, app.info retrieves information about the application, while scope returns a list of available scopes.

User. The method user.admin checks the permissions of the current user before saving settings. The basic data of the current user is obtained through profile.

Overview of Methods

Scope: basic

Who can execute the method: depends on the method