Get Search History im.search.last.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
Deprecated method
The method was designed for the previous version of the chat and is kept only to support existing integrations. In the current M1 chat version, it works, but the result is not displayed in the interface. There is no replacement in the current version.
The method im.search.last.get returns a list of dialogs from the history of the last search.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
SKIP_OPENLINES |
Skip Open Channels chats. Possible values:
Default value — |
|
SKIP_CHAT |
Skip group chats. Possible values:
Default value — |
|
SKIP_DIALOG |
Skip personal dialogs. Possible values:
Default value — |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"SKIP_OPENLINES":"N","SKIP_CHAT":"N","SKIP_DIALOG":"N"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.search.last.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"SKIP_OPENLINES":"N","SKIP_CHAT":"N","SKIP_DIALOG":"N","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.search.last.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
// Shape of each SearchLastItem returned in result[]
type SearchLastItem = {
id: string | number
type: 'chat' | 'user'
avatar: {
url: string
color: string
}
title: string
chat?: {
id: number
name: string
owner: number
extranet: boolean
avatar: string
color: string
type: string
entity_type: string
entity_id: string
entity_data_1: string
entity_data_2: string
entity_data_3: string
mute_list: unknown[]
date_create: ISODate
message_type: string
}
user?: {
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: { personal_mobile: string; 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<SearchLastItem[]>({
method: 'im.search.last.get',
params: {
SKIP_OPENLINES: 'N',
SKIP_CHAT: 'N',
SKIP_DIALOG: 'N',
},
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('Search history entries:', 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 getSearchHistory() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'im.search.last.get',
params: {
SKIP_OPENLINES: 'N',
SKIP_CHAT: 'N',
SKIP_DIALOG: 'N',
},
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('Search history entries:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getSearchHistory)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.im.search.last.get(
skip_openlines=False,
skip_chat=False,
skip_dialog=False,
).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.search.last.get',
[
'SKIP_OPENLINES' => 'N',
'SKIP_CHAT' => 'N',
'SKIP_DIALOG' => 'N',
]
);
$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.search.last.get',
{
SKIP_OPENLINES: 'N',
SKIP_CHAT: 'N',
SKIP_DIALOG: 'N',
},
function(result) {
if (result.error()) {
console.error(result.error().ex);
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'im.search.last.get',
[
'SKIP_OPENLINES' => 'N',
'SKIP_CHAT' => 'N',
'SKIP_DIALOG' => 'N',
]
);
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.search.last.get", b24.Params{
"SKIP_OPENLINES": "N",
"SKIP_CHAT": "N",
"SKIP_DIALOG": "N",
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("im.search.last.get: %w", err)
}
// The response arrives as json.RawMessage — unmarshal it
// into a struct matching the response shape shown below on this page.
fmt.Printf("%s\n", res.Result)
Response Handling
HTTP Status: 200
{
"result": [
{
"id": "chat1157",
"type": "chat",
"avatar": {
"url": "",
"color": "#ab7761"
},
"title": "Brown Chat #18",
"chat": {
"id": 1157,
"name": "Brown Chat #18",
"owner": 27,
"extranet": false,
"avatar": "",
"color": "#ab7761",
"type": "thread",
"entity_type": "THREAD",
"entity_id": "",
"entity_data_1": "",
"entity_data_2": "",
"entity_data_3": "",
"mute_list": [],
"date_create": "2025-01-30T00:41:03+01:00",
"message_type": "C"
}
},
{
"id": 103,
"type": "user",
"avatar": {
"url": "https://example.bitrix24.com/upload/main/avatar.png",
"color": "#4ba984"
},
"title": "Emily Smith",
"user": {
"id": 103,
"active": true,
"name": "Emily Smith",
"first_name": "Emily",
"last_name": "Smith",
"work_position": "IT Department Head",
"color": "#4ba984",
"avatar": "https://example.bitrix24.com/upload/main/avatar.png",
"avatar_hr": "https://example.bitrix24.com/upload/main/avatar.png",
"gender": "F",
"birthday": "08-03",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2026-03-05T10:19:37+01:00",
"mobile_last_date": false,
"desktop_last_date": false,
"absent": false,
"departments": [1, 7],
"phones": {
"personal_mobile": "+491234567890",
"work_phone": "19123456789",
"inner_phone": "78"
},
"bot_data": null,
"type": "user",
"website": "",
"email": "emily@example.com"
}
}
],
"time": {
"start": 1772695649,
"finish": 1772695649.89509,
"duration": 0.8950901031494141,
"processing": 0,
"date_start": "2026-03-05T10:27:29+01:00",
"date_finish": "2026-03-05T10:27:29+01:00",
"operating_reset_at": 1772696249,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
List of search history items. The structure of the item object is described in detail below |
|
time |
Information about the request execution time |
Search History Item
|
Name |
Description |
|
Identifier of the chat or user identifier for personal dialog |
|
|
type |
Record type: |
|
avatar |
Avatar data of the record. The structure of the object is described in detail below |
|
title |
Title of the record |
|
user |
User data for The structure of the object is described in detail below |
|
chat |
Chat data for The structure of the object is described in detail below |
Avatar Object
|
Name |
Description |
|
url |
Link to the avatar |
|
color |
Color in HEX format |
User Object
|
Name |
Description |
|
id |
User identifier |
|
active |
User activity status |
|
name |
User's full name |
|
first_name |
User's first name |
|
last_name |
User's last name |
|
work_position |
User's job title |
|
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 status |
|
idle |
User idle date or |
|
last_activity_date |
User's last activity date |
|
mobile_last_date |
Last activity date in the mobile app or |
|
desktop_last_date |
Last activity date in the desktop app or |
|
absent |
Date of the user's absence end 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 |
Chat Object
|
Name |
Description |
|
id |
Chat identifier |
|
name |
Chat name |
|
owner |
Chat owner identifier |
|
extranet |
Extranet user participation status in the chat |
|
Link to the chat avatar |
|
|
color |
Chat color in HEX format |
|
type |
Chat type |
|
entity_type |
Type of the object to which the chat is linked |
|
entity_id |
Identifier of the object to which the chat is linked |
|
entity_data_1 |
Additional data of the chat object — field 1 |
|
entity_data_2 |
Additional data of the chat object — field 2 |
|
entity_data_3 |
Additional data of the chat object — field 3 |
|
mute_list |
List of users with notifications turned off |
|
date_create |
Chat creation date in ISO 8601 format (RFC3339) |
|
message_type |
Message type |
Error Handling
HTTP Status: 401
{
"error": "INVALID_CREDENTIALS",
"error_description": "Invalid request credentials"
}
The method has no error codes of its own — only system REST API errors are possible.
|
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 |
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 |