Get Notifications im.notify.get
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:
imWho 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.
Notification sorting: first by descending creation date, then by descending identifiers.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
LAST_ID |
Identifier of the last notification from the previous page to load the next one. Typically taken from the 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 |
Technical pagination cursor. Allowed values:
This parameter should be used together with For values other than |
|
LIMIT |
Number of notifications per page. Default value is |
|
CONVERT_TEXT |
Convert notification text. Value |
On one page, the method can return a mixed set of notifications: first confirmations, then regular notifications to reach LIMIT.
For stable pagination:
- pass
LAST_IDof the last element from the previous page - use
LAST_TYPEfrom the previous pagination step
Code Examples
How to Use Examples in Documentation
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
// 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
type NotificationItem = {
id: number
chat_id: number
author_id: number
date: ISODate
notify_type: number
notify_module: string
notify_event: string
notify_tag: string
notify_sub_tag: string
notify_title: string
setting_name: string
text: string
notify_read: string
notify_buttons?: string
params: object | null
}
type UserItem = {
id: number
active: boolean
name: string
first_name: string
last_name: string
work_position: string
color: string
avatar: string
avatar_hr: string
gender: string
birthday: string
extranet: boolean
network: boolean
bot: boolean
connector: boolean
external_auth_id: string
status: string
idle: ISODate | false
last_activity_date: ISODate
mobile_last_date: ISODate | false
desktop_last_date: ISODate | false
absent: ISODate | false
departments: number[]
phones: Record<string, string> | false
bot_data: object | null
type: string
website: string
email: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type ImNotifyGetResult = {
total_count: number
total_unread_count: number
chat_id: number
notifications: NotificationItem[]
users: UserItem[]
}
try {
const response = await $b24.actions.v2.call.make<ImNotifyGetResult>({
method: 'im.notify.get',
params: {
LAST_ID: 1500,
LAST_TYPE: 3,
LIMIT: 20,
CONVERT_TEXT: 'Y',
},
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('Total notifications:', result.total_count, 'Unread:', result.total_unread_count)
console.info('Notifications on page:', result.notifications.length)
}
} 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 getNotifications() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'im.notify.get',
params: {
LAST_ID: 1500,
LAST_TYPE: 3,
LIMIT: 20,
CONVERT_TEXT: 'Y',
},
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('Total notifications:', result.total_count, 'Unread:', result.total_unread_count)
console.info('Notifications on page:', result.notifications.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getNotifications)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.im.notify.get(
last_id=1500,
last_type=3,
limit=20,
convert_text=True,
).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}")
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']);
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "im.notify.get", b24.Params{
"LAST_ID": 1500,
"LAST_TYPE": 3,
"LIMIT": 20,
"CONVERT_TEXT": "Y",
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("im.notify.get: %w", err)
}
var item struct {
TotalCount int `json:"total_count"`
TotalUnreadCount int `json:"total_unread_count"`
ChatID int `json:"chat_id"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.TotalCount, item.TotalUnreadCount)
Response Handling
HTTP Status: 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 |
Description |
|
result |
Object containing notification data. The structure of the object is described in detail below |
|
time |
Information about the execution time of the request |
Result Object
|
Name |
Description |
|
total_count |
Total number of notifications |
|
total_unread_count |
Number of unread notifications |
|
chat_id |
Identifier of the system notification chat |
|
notifications |
List of notifications. The structure of the object is described in detail below |
|
users |
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 |
Description |
|
id |
Identifier of the notification |
|
chat_id |
Identifier of the system notification chat |
|
author_id |
Identifier of the notification author |
|
date |
Date and time of the notification in ISO 8601 format (RFC3339) |
|
notify_type |
Type of notification |
|
notify_module |
Identifier of the notification module |
|
notify_event |
Code of the notification event |
|
notify_tag |
Notification tag |
|
notify_sub_tag |
Additional notification tag |
|
notify_title |
Title of the notification |
|
setting_name |
Code of the setting in the format |
|
text |
Text of the notification |
|
notify_read |
Read status of the notification: |
|
notify_buttons |
JSON keyboard for confirmation type notifications. This field is not always present |
|
Additional parameters of the notification |
Users Object
|
Name |
Description |
|
id |
Identifier of the user |
|
active |
User's activity status |
|
name |
User's full name |
|
first_name |
User's first name |
|
last_name |
User's last name |
|
work_position |
User's position |
|
color |
User's color in hex format |
|
avatar |
Link to the avatar |
|
avatar_hr |
Link to the high-resolution avatar |
|
gender |
User's gender |
|
birthday |
Birthday in |
|
extranet |
Extranet user status |
|
network |
Bitrix24 Network user status |
|
bot |
Bot status |
|
connector |
Open Channels user status |
|
external_auth_id |
External authorization code |
|
status |
User's status |
|
idle |
User's idle date or |
|
last_activity_date |
User's last activity date |
|
mobile_last_date |
User's last activity date in the mobile app or |
|
desktop_last_date |
User's last activity date in the desktop app or |
|
absent |
User's absence end date or |
|
departments |
Array of department identifiers |
|
phones |
User's phones or |
|
bot_data |
Bot data or |
|
type |
User type |
|
website |
User's website |
|
email |
User's email |
Phones Object
|
Name |
Description |
|
work_phone |
Work phone |
|
personal_mobile |
Mobile phone |
|
inner_phone |
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 |
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
|
Code |
Description |
Value |
|
|
Parameters LAST_ID and LAST_TYPE should be used together |
Only one parameter from the pair |
|
|
Last notification ID can't be string |
The |
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
- Send Notification im.notify
- Send Personal Notification im.notify.personal.add
- Send System Notification im.notify.system.add
- Get Notification Type Schema im.notify.schema.get
- Read the list of notifications im.notify.read.list
- Read or Mark Notification as Unread im.notify.read
- Read All Notifications im.notify.read.all
- Responding to Notifications with Quick Response im.notify.answer
- Interacting with Notification Buttons im.notify.confirm
- Delete Notification im.notify.delete
- Searching Notification History im.notify.history.search