Get App Configurations BX24.appOption.get

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.

BX24.appOption.get(string name): mixed;
        

The BX24.appOption.get method returns a configuration by its code.

Method Parameters

Required parameters are marked with *

Name
type

Description

name*
string

Parameter code

Code Examples

BX24.init(() => {
            BX24.appOption.set('param_str', 'str1', (params) => console.log(params));
            BX24.appOption.set('param_numb', 1);
        
            console.log(BX24.appOption.get('param_str')); //returns str1
            console.log(BX24.appOption.get('param_numb'));//returns 1
        });
        

How to Use Examples in Documentation

Return Value

Returns the value of the app configuration with the name name. The value type depends on what was retained by the BX24.appOption.set method.

Continue Learning