Get the List of Event Log Fields main.eventlog.field.list
Scope:
mainWho can execute the method: administrator
The method main.eventlog.field.list returns a list of available fields for event log entries.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
select |
List of description fields to return in the response. Available 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.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"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.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["name","type","title","description","filterable","sortable","multiple"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/main.eventlog.field.list
The SDK does not currently support the address /rest/api/ in calls. Use direct HTTP requests, for example, via curl or fetch.
try
{
const response = await $b24.callMethod(
'main.eventlog.field.list',
{
select: [
'name',
'type',
'title',
'description',
'filterable',
'sortable',
'multiple'
]
}
);
const result = response.getData().result;
console.log('Event log fields:', result);
}
catch( error )
{
console.error('Error:', error);
}
The SDK does not currently support the address /rest/api/ in calls. Use direct HTTP requests, for example, via curl or fetch.
try {
$response = $b24Service
->core
->call(
'main.eventlog.field.list',
[
'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 currently support the address /rest/api/ in calls. Use direct HTTP requests, for example, via curl or fetch.
BX24.callMethod(
'main.eventlog.field.list',
{
select: [
'name',
'type',
'title',
'description',
'filterable',
'sortable',
'multiple'
]
},
function(result){
console.info(result.data());
console.log(result);
}
);
The SDK does not currently support the address /rest/api/ in calls. Use direct HTTP requests, for example, via curl or fetch.
require_once('crest.php');
$result = CRest::call(
'main.eventlog.field.list',
[
'select' => [
'name',
'type',
'title',
'description',
'filterable',
'sortable',
'multiple'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"items": [
{
"name": "id",
"type": "int",
"title": "id",
"description": null,
"filterable": true,
"sortable": true,
"multiple": false
},
{
"name": "timestampX",
"type": "object",
"title": "timestampX",
"description": null,
"filterable": true,
"sortable": true,
"multiple": false
},
{
"name": "severity",
"type": "string",
"title": "severity",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "auditTypeId",
"type": "string",
"title": "auditTypeId",
"description": null,
"filterable": true,
"sortable": true,
"multiple": false
},
{
"name": "moduleId",
"type": "string",
"title": "moduleId",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "itemId",
"type": "string",
"title": "itemId",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "remoteAddr",
"type": "string",
"title": "remoteAddr",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "userAgent",
"type": "string",
"title": "userAgent",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "requestUri",
"type": "string",
"title": "requestUri",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "siteId",
"type": "string",
"title": "siteId",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
},
{
"name": "userId",
"type": "int",
"title": "userId",
"description": null,
"filterable": true,
"sortable": true,
"multiple": false
},
{
"name": "guestId",
"type": "int",
"title": "guestId",
"description": null,
"filterable": true,
"sortable": true,
"multiple": false
},
{
"name": "description",
"type": "string",
"title": "description",
"description": null,
"filterable": false,
"sortable": false,
"multiple": false
}
]
},
"time": {
"start": 1769780464,
"finish": 1769780464.122003,
"duration": 0.1220030784606934,
"processing": 0,
"date_start": "2026-01-30T16:41:04+02:00",
"date_finish": "2026-01-30T16:41:04+02:00",
"operating_reset_at": 1769781064,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object containing the response data |
|
items |
Array of objects describing the fields. The response structure depends on |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION",
"message": "Unknown field `unknownField` for entity `DtoFieldDto`"
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
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 main scope |
Errors in the select Parameter
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Unknown field |
Only pass fields from the list: |
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Unable to recognize select expression |
Pass |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- Get Event Log Field main.eventlog.field.get
- Get the list of event log entries main.eventlog.list
- Event Log: Overview of Methods