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

Scope: basic

Who can execute the method: administrator

The event.offline.list method reads the offline event queue of the application that called it. Unlike event.offline.get, it does not reserve records and does not return process_id. To confirm records or mark them as erroneous, retrieve them with the event.offline.get method with clear=0.

The method works only in the context of authorizing the application.

Method Parameters

Required parameters are marked with *

Name
type

Description

filter
object

Record filter. Without a filter, the method returns all records. You can filter by the fields: ID, TIMESTAMP_X, EVENT_NAME, MESSAGE_ID, PROCESS_ID, ERROR.

TIMESTAMP_X is passed in ISO 8601 format, ERROR — as 0 or 1.

The operation is specified before the field name: =, >, <, >=, <=, @ — the value is in the array, % — substring. Without an operation, an exact match is used. Example: {">ID": 100, "=EVENT_NAME": "ONCRMLEADADD"}. Negation ! is not supported: the method returns the ERROR_ARGUMENT error

order
object

Record sorting by the same fields as in the filter, in the form {"field": "ASC"} or {"field": "DESC"}. Default is {"ID": "ASC"}

start
integer

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 50. To select the third page of results — the value 100, and so on.

The formula for calculating the start parameter value:

start = (N-1) * 50, where N — the number of the desired page

auth_connector
string

Source key. The queue of offline events is divided by sources. Pass the same auth_connector value as when subscribing with the event.bind method; otherwise, the method will return only events without a source. The parameter is not available on all plans: check its availability using the feature.get method with the code rest_auth_connector, otherwise the method returns the WRONG_LICENSE error

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 ignore `order` (they always sort by ID ASC and log a warning)
          // — 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 ignore `order` (they always sort by ID ASC and log a warning)
              // — 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,
                },
            ).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();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $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       json.RawMessage `json:"EVENT_DATA"`
        	EventAdditional json.RawMessage `json:"EVENT_ADDITIONAL"`
        	MessageID       string          `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": {
                        "FIELDS": {
                            "ID": "45"
                        }
                    },
                    "EVENT_ADDITIONAL": {
                        "user_id": "1"
                    },
                    "MESSAGE_ID": "4f2a9c1e7b3d5a6f8e0c2b4d6a8f1e3c",
                    "PROCESS_ID": "",
                    "ERROR": "0"
                },
                {
                    "ID": "1",
                    "TIMESTAMP_X": "2024-07-18T12:32:31+02:00",
                    "EVENT_NAME": "ONCRMLEADADD",
                    "EVENT_DATA": {
                        "FIELDS": {
                            "ID": "123"
                        }
                    },
                    "EVENT_ADDITIONAL": {
                        "user_id": 0
                    },
                    "MESSAGE_ID": "b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3",
                    "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
type

Description

result
array

Queue records (detailed description). If there are no matching records, an empty array is returned

total
integer

The total number of records found

next
integer

The start value for the next page. Returned if more records are found than fit on the current page

time
time

Information about the request execution time

List Element

Name
type

Description

ID
string

Identifier of the record in the queue

TIMESTAMP_X
datetime

Time the event was written to the queue or last repeated

EVENT_NAME
string

Event code, for example ONCRMLEADADD

EVENT_DATA
object or boolean

Event data — the same as passed to the handler of an online event, for example FIELDS.ID. If the event has no data, the field is empty: false or null

EVENT_ADDITIONAL
object

Event authorization data. The user_id field contains the identifier of the user who performed the action. If the action was performed without a user, for example by an agent, user_id is 0

MESSAGE_ID
string

Record key. A repeated event with the same data updates the unreserved record instead of adding a new one. If the record is already reserved by a batch, the repeat creates a new record. Pass the value in the message_id parameter of the event.offline.clear and event.offline.error methods

PROCESS_ID
string

Identifier of the batch that reserved the record via the event.offline.get method with clear=0. An empty string if the record is not reserved

ERROR
string

1 — the record is marked as erroneous by the event.offline.error method, 0 — it is not

Error Handling

HTTP status: 403

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied!"
        }
        

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

Status

Code

Description

Value

400

ERROR_ARGUMENT

Filter field not allowed: …

A field not from the list was passed in filter

400

ERROR_ARGUMENT

Filter operation not allowed: …

An unsupported operation was passed in filter, for example !

400

ERROR_ARGUMENT

The filter is not an array.

The filter parameter was not passed as an object

400

ERROR_ARGUMENT

The order is not an array.

The order parameter was not passed as an object

400

ERROR_ARGUMENT

Order field not allowed: …

A field not from the list was passed in order

400

ERROR_ARGUMENT

Order direction should be one of {ASC|DESC}

A direction other than ASC or DESC was passed in order

403

ACCESS_DENIED

Access denied!

The method was called by a non-administrator

403

WRONG_AUTH_TYPE

Current authorization type is denied for this method

The method was called outside an application, for example, through a webhook

403

WRONG_LICENSE

This feature is not enabled for the current license: auth_connector

auth_connector was passed, but the plan does not support source keys

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

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 — 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