Get a List of Offline Events event.offline.list
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Who can execute the method: administrator
A event.offline.list method for reading the current queue without making changes to its state, unlike event.offline.get. The availability of offline events can be checked via the feature.get method.
The method does not mark events as processed and does not generate process_id. In the PROCESS_ID field, the value is empty until events are reserved by a call to event.offline.get with the clear=0 parameter.
The method works only in the context of authorizing the application.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
filter |
Record filter. By default, all records are returned without filtering. Filtering is supported by fields: |
|
order |
Record sorting. Sorting is supported by the same fields as in the filter; an array of the type |
|
start |
This parameter is used to control pagination. The page size of results is always static: 50 records. To select the second page of results, you need to pass the value The formula for calculating the
|
|
auth_connector |
Source key. The queue of offline events is divided by sources. Pass the same |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"filter": {
"ERROR": 0
},
"order": {
"ID": "DESC"
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/event.offline.list
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each OfflineEventItem returned in result[]
type OfflineEventItem = {
ID: string
TIMESTAMP_X: ISODate
EVENT_NAME: string
EVENT_DATA: unknown
EVENT_ADDITIONAL: unknown
MESSAGE_ID: string
PROCESS_ID: string
ERROR: string
}
try {
// event.offline.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<OfflineEventItem[]>({
method: 'event.offline.list',
params: {
filter: {
ERROR: 0,
},
order: {
ID: 'DESC',
},
start: 0,
},
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('Offline events:', result.length, 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 fetchOfflineEvents() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// event.offline.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'event.offline.list',
params: {
filter: {
ERROR: 0,
},
order: {
ID: 'DESC',
},
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Offline events:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchOfflineEvents)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.event.offline.list(
filter={
"ERROR": 0,
},
order={
"ID": "DESC",
},
start=0,
).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 as_list
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.event.offline.list(
filter={
"ERROR": 0,
},
order={
"ID": "DESC",
},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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 as_list_fast
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.event.offline.list(
filter={
"ERROR": 0,
},
order={
"ID": "DESC",
},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
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}")
try {
$response = $b24Service
->core
->call(
'event.offline.list',
[
'filter' => [
'ERROR' => 0,
],
'order' => [
'ID' => 'DESC',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching offline events: ' . $e->getMessage();
}
BX24.callMethod(
"event.offline.list",
{
"filter": {
"ERROR": 0
},
"order": {
"ID": "DESC"
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'event.offline.list',
[
'filter' => [
'ERROR' => 0
],
'order' => [
'ID' => 'DESC'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "event.offline.list", b24.Params{
"filter": b24.Params{
"ERROR": 0,
},
"order": b24.Params{
"ID": "DESC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("event.offline.list: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
TimestampX string `json:"TIMESTAMP_X"`
EventName string `json:"EVENT_NAME"`
EventData bool `json:"EVENT_DATA"`
EventAdditional bool `json:"EVENT_ADDITIONAL"`
MessageID b24.ID `json:"MESSAGE_ID"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.TimestampX)
}
// Total and Next are filled in by list methods; for a full
// list traversal, use client.Core().Pages and Scan.
if res.Total != nil {
fmt.Println("total:", *res.Total)
}
Response Handling
HTTP status: 200
{
"result": [
{
"ID": "2",
"TIMESTAMP_X": "2024-07-18T12:32:31+02:00",
"EVENT_NAME": "ONCRMCOMPANYADD",
"EVENT_DATA": false,
"EVENT_ADDITIONAL": false,
"MESSAGE_ID": "2",
"PROCESS_ID": "",
"ERROR": "0"
},
{
"ID": "1",
"TIMESTAMP_X": "2024-07-18T12:32:31+02:00",
"EVENT_NAME": "ONCRMLEADADD",
"EVENT_DATA": false,
"EVENT_ADDITIONAL": false,
"MESSAGE_ID": "1",
"PROCESS_ID": "",
"ERROR": "0"
}
],
"total": 2,
"time": {
"start": 1721299537.90267,
"finish": 1721299538.02201,
"duration": 0.11934018135070801,
"processing": 0.0029511451721191406,
"date_start": "2024-07-18T12:45:37+02:00",
"date_finish": "2024-07-18T12:45:38+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
total |
The total number of records found |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 403
{
"error": "ACCESS_DENIED",
"error_description": "Access denied!"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Access denied! |
Method was executed by a non-administrator |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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
- Get a List of Available Events
- Register a New Event Handler event.bind
- Retrieve a List of Registered Event Handlers event.get
- Unregister Event Handler event.unbind
- Security in Handlers
- Offline Events
- Retrieve a List of Offline Events With Cleanup event.offline.get
- Clear Offline Event Queue event.offline.clear
- Register Offline Event Queue Processing Errors event.offline.error
- Event on New Entries in the Offline Event Queue onOfflineEvent