Get Notifications im.notify.get

Scope: im

Who can execute the method: any user

The method im.notify.get returns a list of user notifications in parts. The next part is requested using LAST_ID and LAST_TYPE.

Notifications are sorted first by descending creation date, then by descending identifiers.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
LAST_ID `integer`	Identifier of the last notification from the previous page to load the next one. Typically taken from the `id` field of the last element in the `notifications` array in the response of the previous step or in the response of im.notify.history.search The notification identifier is also returned by the methods im.notify, im.notify.personal.add, and im.notify.system.add. This parameter should be used together with `LAST_TYPE`
LAST_TYPE `integer`	Technical pagination cursor. Allowed values: `1` — continue fetching from the confirmations stage `3` — continue fetching from the regular notifications stage This parameter should be used together with `LAST_ID`. For values other than `1` and `3`, the server does not return a separate error.
LIMIT `integer`	Number of notifications per page. Default value is `50`. Maximum value is `50`.
CONVERT_TEXT `string`	Convert notification text. Value `Y` enables conversion, any other value disables it.

On a single page, the method can return a mixed set of notifications: first confirmations, then regular notifications to reach LIMIT.

For stable pagination:

pass LAST_ID of the last element from the previous page
use LAST_TYPE from the previous pagination step

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"LAST_ID":1500,"LAST_TYPE":3,"LIMIT":20,"CONVERT_TEXT":"Y"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.notify.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"LAST_ID":1500,"LAST_TYPE":3,"LIMIT":20,"CONVERT_TEXT":"Y","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.notify.get

try {
          const response = await $b24.callMethod('im.notify.get', {
            LAST_ID: 1500,
            LAST_TYPE: 3,
            LIMIT: 20,
            CONVERT_TEXT: 'Y',
          });
        
          const { result } = response.getData();
          console.log(result);
        } catch (error) {
          console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'im.notify.get',
                [
                    'LAST_ID' => 1500,
                    'LAST_TYPE' => 3,
                    'LIMIT' => 20,
                    'CONVERT_TEXT' => 'Y',
                ]
            );
        
            $result = $response->getResponseData()->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                var_dump($result->data());
            }
        } catch (Throwable $exception) {
            echo $exception->getMessage();
        }

BX24.callMethod(
            'im.notify.get',
            {
                LAST_ID: 1500,
                LAST_TYPE: 3,
                LIMIT: 20,
                CONVERT_TEXT: 'Y',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.notify.get',
            [
                'LAST_ID' => 1500,
                'LAST_TYPE' => 3,
                'LIMIT' => 20,
                'CONVERT_TEXT' => 'Y',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            var_dump($result['result']);
        }

Response Handling

HTTP Code: 200

{
            "result": {
                "total_count": 120,
                "total_unread_count": 5,
                "chat_id": 77,
                "notifications": [
                    {
                        "id": 1500,
                        "chat_id": 77,
                        "author_id": 1,
                        "date": "2026-03-03T09:00:00+00:00",
                        "notify_type": 2,
                        "notify_module": "rest",
                        "notify_event": "rest_notify",
                        "notify_tag": "MP|12345|TASK_42",
                        "notify_sub_tag": "MP|12345|TASK|42",
                        "notify_title": "",
                        "setting_name": "rest|rest_notify",
                        "text": "Reminder",
                        "notify_read": "N",
                        "params": null
                    }
                ],
                "users": [
                    {
                        "id": 1,
                        "active": true,
                        "name": "John Smith",
                        "first_name": "John",
                        "last_name": "Smith",
                        "work_position": "",
                        "color": "#1eb4aa",
                        "avatar": "https://example.bitrix24.com/upload/main/avatar.png",
                        "avatar_hr": "https://example.bitrix24.com/upload/main/avatar.png",
                        "gender": "M",
                        "birthday": "15-05",
                        "extranet": false,
                        "network": false,
                        "bot": false,
                        "connector": false,
                        "external_auth_id": "socservices",
                        "status": "online",
                        "idle": false,
                        "last_activity_date": "2026-03-03T15:04:20+02:00",
                        "mobile_last_date": false,
                        "desktop_last_date": false,
                        "absent": false,
                        "departments": [1],
                        "phones": {
                            "work_phone": "+11234567890",
                            "inner_phone": "22"
                        },
                        "bot_data": null,
                        "type": "user",
                        "website": "example.com",
                        "email": "john@example.com"
                    }
                ]
            },
            "time": {
                "start": 1760000000.0,
                "finish": 1760000000.1,
                "duration": 0.1,
                "processing": 0.04,
                "date_start": "2026-03-03T10:00:00+02:00",
                "date_finish": "2026-03-03T10:00:00+02:00",
                "operating_reset_at": 1760030000,
                "operating": 0
            }
        }

Returned Data

Name
Type

Description

result
object

Object containing notification data.

The structure of the object is described in detail below

time
time

Information about the request execution time

Result Object

Name `Type`	Description
total_count `integer`	Total number of notifications
total_unread_count `integer`	Number of unread notifications
chat_id `integer`	Identifier of the system notification chat
notifications `array`	List of notifications. The structure of the object is described in detail below
users `array`	Array of objects containing data about notification authors. The structure of the object is described in detail below

If the user does not have a system notification chat or it contains no messages, the method returns only the notifications and users fields.

Notification Object

Name `Type`	Description
id `integer`	Identifier of the notification
chat_id `integer`	Identifier of the system notification chat
author_id `integer`	Identifier of the notification author
date `string`	Date and time of the notification in ISO 8601 format (RFC3339)
notify_type `integer`	Type of notification
notify_module `string`	Identifier of the notification module
notify_event `string`	Code of the notification event
notify_tag `string`	Notification tag
notify_sub_tag `string`	Additional notification tag
notify_title `string`	Title of the notification
setting_name `string`	Code of the setting in the format `MODULE\|EVENT`
text `string`	Text of the notification
notify_read `string`	Read status of the notification: `Y` or `N`
notify_buttons `string`	JSON keyboard for confirmation-type notifications. This field is not always present
params `object` `null`	Additional parameters of the notification

Users Object

Name `Type`	Description
id `integer`	User identifier
active `boolean`	User account activity status
name `string`	User's full name
first_name `string`	User's first name
last_name `string`	User's last name
work_position `string`	User's job title
color `string`	User's color in HEX format
avatar `string` `null`	Link to the user's avatar
avatar_hr `string` `null`	Link to the high-resolution avatar. Currently, this field always returns a value, regardless of the `AVATAR_HR` setting
gender `string`	User's gender: `M`, `F`, or empty if not specified
birthday `string`	Birthday in `DD-MM` format or an empty string
extranet `boolean`	Extranet user status
network `boolean`	Bitrix24 Network user status
bot `boolean`	Bot user status
connector `boolean`	Open Channels connector user status
external_auth_id `string`	External authentication identifier
status `string`	User status. In the new messenger, this field always contains `online` regardless of the actual status set. The current status can be checked using the im.user.status.get method, and changed using the im.user.status.set method
idle `string` `boolean`	Time of transition to "Away" status in ISO 8601 (RFC3339) format or `false`
last_activity_date `string` `boolean`	Time of last activity in ISO 8601 (RFC3339) format or `false`
mobile_last_date `string` `boolean`	Time of last activity in the mobile application in ISO 8601 (RFC3339) format or `false`
desktop_last_date `string` `boolean`	Time of last activity in the desktop application in ISO 8601 (RFC3339) format or `false`
absent `string` `boolean`	Date of absence end in ISO 8601 (RFC3339) format or `false`
departments `array`	Array of department identifiers
phones `object` `boolean`	User's phones or `false`. The structure of the object is described in detail below
website `string`	User's website or an empty string
email `string`	User's email or an empty string
bot_data `object` `null`	Bot data for bot users
type `string`	User type

Phones Object

Name `Type`	Description
personal_mobile `string`	Mobile phone
work_phone `string`	Work phone
inner_phone `string`	Internal phone

Error Handling

HTTP Status: 400

{
            "error": "LAST_ID_AND_LAST_TYPE",
            "error_description": "Parameters LAST_ID and LAST_TYPE should be used together."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`LAST_ID_AND_LAST_TYPE`	Parameters LAST_ID and LAST_TYPE should be used together	Only one parameter from the pair `LAST_ID` and `LAST_TYPE` was provided
`LAST_ID_STRING`	Last notification ID can't be string	The `LAST_ID` parameter contains a non-numeric value

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

Send System Notification

Get Notification Types Schema

Get Notifications im.notify.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ObjectResult Object

Notification ObjectNotification Object

Users ObjectUsers Object

Phones ObjectPhones Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning