Get Event Log Field main.eventlog.field.get

Scope: main

Who can execute the method: administrator

The method main.eventlog.field.get returns the description of the event log field by name.

Method Parameters

Required parameters are marked with *

Name
type

Description

name*
string

The name of the field whose description is to be retrieved

select
array

A list of description fields to return in the response.

Available fields:

name — field name
type — data type
title — title
description — description
validationRules — validation rules
requiredGroups — required groups
filterable — filter availability indicator
sortable — sort availability indicator
editable — editability indicator
multiple — multiple value indicator
elementType — element type for composite fields

Code Examples

How to Use Examples in Documentation

The new API call differs by the addition of the /api/ parameter in the request:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/main.eventlog.field.get

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"name":"timestampX","select":["name","type","title","description","filterable","sortable","multiple"]}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/main.eventlog.field.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"name":"timestampX","select":["name","type","title","description","filterable","sortable","multiple"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/main.eventlog.field.get

The SDK does not yet support the /rest/api/ address in calls. Use direct HTTP requests, such as via curl or fetch.

try
        {
            const response = await $b24.callMethod(
                'main.eventlog.field.get',
                {
                    name: 'timestampX',
                    select: [
                        'name',
                        'type',
                        'title',
                        'description',
                        'filterable',
                        'sortable',
                        'multiple'
                    ]
                }
            );
        
            const result = response.getData().result;
            console.log('Event log field:', result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

The SDK does not yet support the /rest/api/ address in calls. Use direct HTTP requests, such as via curl or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'main.eventlog.field.get',
                    [
                        'name' => 'timestampX',
                        'select' => [
                            'name',
                            'type',
                            'title',
                            'description',
                            'filterable',
                            'sortable',
                            'multiple'
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

The SDK does not yet support the /rest/api/ address in calls. Use direct HTTP requests, such as via curl or fetch.

BX24.callMethod(
            'main.eventlog.field.get',
            {
                name: 'timestampX',
                select: [
                    'name',
                    'type',
                    'title',
                    'description',
                    'filterable',
                    'sortable',
                    'multiple'
                ]
            },
            function(result){
                console.info(result.data());
                console.log(result);
            }
        );

The SDK does not yet support the /rest/api/ address in calls. Use direct HTTP requests, such as via curl or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'main.eventlog.field.get',
            [
                'name' => 'timestampX',
                'select' => [
                    'name',
                    'type',
                    'title',
                    'description',
                    'filterable',
                    'sortable',
                    'multiple'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "item": {
                    "name": "timestampX",
                    "type": "object",
                    "title": "DATE_CREATE",
                    "description": "Date and time of the event",
                    "validationRules": [],
                    "requiredGroups": null,
                    "filterable": true,
                    "sortable": true,
                    "editable": false,
                    "multiple": false,
                    "elementType": null
                }
            },
            "time": {
                "start": 1769780771,
                "finish": 1769780771.081992,
                "duration": 0.08199191093444824,
                "processing": 0,
                "date_start": "2026-01-30T16:46:11+01:00",
                "date_finish": "2026-01-30T16:46:11+01:00",
                "operating_reset_at": 1769781371,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with response data
item `object`	Object with field description. The response structure depends on `select`
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error during request object validation",
                "validation": [
                    {
                        "field": "name",
                        "message": "Required field `name` is not specified"
                    }
                ]
            }
        }

Name `type`	Description
error.code `string`	String error code. Use it to identify the type of exception
error.message `string`	Text description of the error
error.validation `array`	Array with error details. Present only in data validation errors `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Name of the field where the validation error occurred
error.validation[].message `string`	Description of the error related to the specified field

Possible Error Codes

Access Errors

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field	Error Description	How to Fix
`-`	Access denied	No administrator rights or missing scope main

Data Not Found Errors

Error Code: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION

Field	Error Description	How to Fix
`name`	Field `#FIELD#` not found	Specify an existing field name

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field	Error Description	How to Fix
`name`	Required field `name` is not specified	Pass the `name` parameter with an existing field name

Errors in the select Parameter

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field	Error Description	How to Fix
`select`	Unknown field `#FIELD#` for entity `DtoFieldDto`	Only pass fields from the list: `name`, `type`, `title`, `description`, `validationRules`, `requiredGroups`, `filterable`, `sortable`, `editable`, `multiple`, `elementType`

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION

Field	Error Description	How to Fix
`select`	Unable to recognize select expression `#SELECT#`	Pass `select` as an array of strings, e.g., `["name","type"]`

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Retrieve Event Log Fields

Overview of Methods

Get Event Log Field main.eventlog.field.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Access ErrorsAccess Errors

Data Not Found ErrorsData Not Found Errors

Request Validation ErrorsRequest Validation Errors

Errors in the select ParameterErrors in the select Parameter

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Access Errors

Data Not Found Errors

Request Validation Errors

Errors in the select Parameter

Statuses and System Error Codes

Continue Learning