Get User Settings BX24.userOption.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.userOption.get(string name): mixed;

The BX24.userOption.get method returns the value of the setting named name for the current user.

Method Parameters

Required parameters are marked with *

Name `type`	Description
name* `string`	Parameter code

Code Examples

BX24.init(() => {
            BX24.userOption.set('param_str', 'str');
            BX24.userOption.set('param_numb', 1);
            BX24.userOption.set('param_obj', {foo: 'bar'});
        
            console.log(BX24.userOption.get('param_str')); //returns str
            console.log(BX24.userOption.get('param_numb')); //returns 1
            console.log(BX24.userOption.get('param_obj')); //returns {foo: 'bar'}
        });