Searching Notification History im.notify.history.search
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
imWho can execute the method: any user
The method im.notify.history.search performs a search through the user's notification history.
Notifications are sorted first by descending creation date, then by descending identifiers.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
SEARCH_TEXT |
Search text. If |
|
SEARCH_TYPE |
Filter by notification type in the format |
|
SEARCH_TYPES |
Array of filters by notification types in the format |
|
SEARCH_DATE |
Date filter in ISO 8601 format (RFC3339) |
|
SEARCH_DATE_FROM |
Start of the date range in ISO 8601 format (RFC3339). Used together with |
|
SEARCH_DATE_TO |
End of the date range in ISO 8601 format (RFC3339). Used together with |
|
SEARCH_AUTHORS |
Array of notification author identifiers for filtering |
|
LAST_ID |
Identifier of the last notification from the previous page to load the next one. Usually taken from the |
|
LIMIT |
Number of notifications per page. Default value is |
|
CONVERT_TEXT |
Convert notification text. Value |
|
GROUP_TAG |
Group tag for notifications for additional filtering |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"SEARCH_TEXT":"invoice","SEARCH_TYPE":"tasks|task_update","SEARCH_DATE":"2026-03-03T16:52:29+01:00","LAST_ID":1500,"LIMIT":20,"CONVERT_TEXT":"Y","GROUP_TAG":"TASK|42"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.notify.history.search
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"SEARCH_TEXT":"invoice","SEARCH_TYPE":"tasks|task_update","SEARCH_DATE":"2026-03-03T16:52:29+01:00","LAST_ID":1500,"LIMIT":20,"CONVERT_TEXT":"Y","GROUP_TAG":"TASK|42","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.notify.history.search
// 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 the payload returned in result (match the "response handling" section of the page)
type NotifyHistorySearchResult = {
chat_id: number
total_results: number
notifications: Array<{
id: number
chat_id: number
author_id: number
date: ISODate | null
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
params: object | null
}>
users: Array<{
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 | null
mobile_last_date: ISODate | false
desktop_last_date: ISODate | false
absent: ISODate | false
departments: number[]
phones: { work_phone?: string; inner_phone?: string } | false
bot_data: object | null
type: string
website: string
email: string
}>
}
try {
const response = await $b24.actions.v2.call.make<NotifyHistorySearchResult>({
method: 'im.notify.history.search',
params: {
SEARCH_TEXT: 'invoice',
SEARCH_TYPE: 'tasks|task_update',
SEARCH_DATE: '2026-03-03T16:52:29+03:00',
LAST_ID: 1500,
LIMIT: 20,
CONVERT_TEXT: 'Y',
GROUP_TAG: 'TASK|42',
},
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(
result.chat_id,
result.total_results,
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 searchNotifyHistory() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'im.notify.history.search',
params: {
SEARCH_TEXT: 'invoice',
SEARCH_TYPE: 'tasks|task_update',
SEARCH_DATE: '2026-03-03T16:52:29+03:00',
LAST_ID: 1500,
LIMIT: 20,
CONVERT_TEXT: 'Y',
GROUP_TAG: 'TASK|42',
},
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(
result.chat_id,
result.total_results,
result.notifications.length,
)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', searchNotifyHistory)
</script>
try {
$response = $b24Service->core->call(
'im.notify.history.search',
[
'SEARCH_TEXT' => 'invoice',
'SEARCH_TYPE' => 'tasks|task_update',
'SEARCH_DATE' => '2026-03-03T16:52:29+01:00',
'LAST_ID' => 1500,
'LIMIT' => 20,
'CONVERT_TEXT' => 'Y',
'GROUP_TAG' => 'TASK|42',
]
);
$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.history.search',
{
SEARCH_TEXT: 'invoice',
SEARCH_TYPE: 'tasks|task_update',
SEARCH_DATE: '2026-03-03T16:52:29+01:00',
LAST_ID: 1500,
LIMIT: 20,
CONVERT_TEXT: 'Y',
GROUP_TAG: 'TASK|42',
},
function(result) {
if (result.error()) {
console.error(result.error().ex);
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'im.notify.history.search',
[
'SEARCH_TEXT' => 'invoice',
'SEARCH_TYPE' => 'tasks|task_update',
'SEARCH_DATE' => '2026-03-03T16:52:29+01:00',
'LAST_ID' => 1500,
'LIMIT' => 20,
'CONVERT_TEXT' => 'Y',
'GROUP_TAG' => 'TASK|42',
]
);
if (!empty($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
var_dump($result['result']);
}
Response Handling
HTTP Code: 200
{
"result": {
"chat_id": 77,
"total_results": 1,
"notifications": [
{
"id": 1500,
"chat_id": 77,
"author_id": 1,
"date": "2026-03-03T09:00:00+00:00",
"notify_type": 2,
"notify_module": "tasks",
"notify_event": "task_update",
"notify_tag": "TASK|42",
"notify_sub_tag": "",
"notify_title": "",
"setting_name": "tasks|task_update",
"text": "invoice",
"notify_read": "Y",
"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-04T15:04:20+01: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-04T16:00:00+01:00",
"date_finish": "2026-03-04T16:00:00+01:00",
"operating_reset_at": 1760030000,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object containing the search result. The structure of the object is described in detail below |
|
time |
Information about the request execution time |
Result Object
|
Name |
Description |
|
chat_id |
Identifier of the system notification chat |
|
total_results |
Total number of search results. This field is returned only on the first page of the search |
|
notifications |
List of notifications. The structure of the object is described in detail below |
|
users |
Users who authored the notifications The structure of the object is described in detail below |
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 |
User Object
|
Name |
Description |
|
id |
Identifier of the user |
|
active |
User's active 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 |
External 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 application or |
|
desktop_last_date |
User's last activity date in the desktop application 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 |
|
personal_mobile |
Mobile phone |
|
inner_phone |
Internal phone |
Error Handling
HTTP Status: 400
{
"error": "SEARCH_TEXT_ERROR",
"error_description": "SEARCH_TEXT can't be less than 3 symbols"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
SEARCH_TEXT can't be less than 3 symbols |
This error occurs if |
|
|
Last notification ID can't be string |
The |
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 permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 Notifications im.notify.get
- 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