Get User Data Associated with the Application user.option.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.

Scope: basic

Who can execute the method: any user

The method user.option.get retrieves user data associated with the application. If no input is provided, it will return all properties recorded through user.option.set.

Method Parameters

Required parameters are marked with *

Name
type

Description

option
string

One of the keys saved by the user.option.set method.

If the parameter is not provided, the method returns all saved settings of the current user

Code Examples

How to Use Examples in Documentation

Example #1

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "option": "data"
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.option.get
        

Example #2

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.option.get
        

Example #1

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "option": "data",
            "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/user.option.get
        

Example #2

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/user.option.get
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type UserOptionResult = Record<string, string>
        
        // Example 1: get a specific option by key
        try {
          const response = await $b24.actions.v2.call.make<UserOptionResult>({
            method: 'user.option.get',
            params: {
              option: 'data',
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Option value:', result['data'])
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
        // Example 2: get all options (no parameters)
        try {
          const response = await $b24.actions.v2.call.make<UserOptionResult>({
            method: 'user.option.get',
            params: {},
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('All options:', Object.keys(result), result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getUserOptions() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // Example 1: get a specific option by key
              const response1 = await $b24.actions.v2.call.make({
                method: 'user.option.get',
                params: {
                  option: 'data',
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response1.isSuccess) {
                console.error(response1.getErrorMessages().join('; '))
                return
              }
        
              const result1 = response1.getData().result
              console.info('Option value:', result1['data'])
        
              // Example 2: get all options (no parameters)
              const response2 = await $b24.actions.v2.call.make({
                method: 'user.option.get',
                params: {},
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response2.isSuccess) {
                console.error(response2.getErrorMessages().join('; '))
                return
              }
        
              const result2 = response2.getData().result
              console.info('All options:', Object.keys(result2), result2)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getUserOptions)
        </script>
        

Example №1

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.user.option.get(
                option="data",
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

Example №2

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.user.option.get().response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

Example #1

require_once('crest.php');
        
        $result = CRest::call(
            'user.option.get',
            [
                'option' => 'data'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Example #2

require_once('crest.php');
        
        $result = CRest::call(
            'user.option.get',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "user.option.get", b24.Params{
        	"option": "data",
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("user.option.get: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)
        

Response Handling

HTTP Status: 200

A call without the option parameter — the method returns all saved settings of the current user:

{
            "result": {
                "data": "value",
                "data2": "value2"
            },
            "time": {
                "start": 1722001311.94644,
                "finish": 1722001311.98622,
                "duration": 0.0397801399230957,
                "processing": 0.000041961669921875,
                "date_start": "2024-07-26T13:41:51+00:00",
                "date_finish": "2024-07-26T13:41:51+00:00",
                "operating": 0
            }
        }
        

A call with the option parameter — the method returns the value of a single key:

{
            "result": "value",
            "time": {
                "start": 1722001311.94644,
                "finish": 1722001311.98622,
                "duration": 0.0397801399230957,
                "processing": 0.000041961669921875,
                "date_start": "2024-07-26T13:41:51+00:00",
                "date_finish": "2024-07-26T13:41:51+00:00",
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object|string|null

Depends on the option parameter:

  • the parameter is not provided — an object where the key is the setting name and the value is the saved value. If there are no settings, the object is empty
  • the parameter is provided — the saved value of the key
  • the parameter is provided, but there is no such key — null

time
time

Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error":"AccessException",
            "error_description":"Application context required"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Error Message

Description

AccessException

Application context required

The method is called outside the application context

AccessException

User authorization required

The user is not authorized

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

The REST API is available only on commercial plans. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning