For AI agents: markdown of this page — /docs-content-en/chats/discovery/recent.md documentation index — /llms.txt

Recent dialogs

GET /v1/chats/recent

Returns the list of the current user's recent dialogs: pinned dialogs first, then by the time of the last message. Each item contains brief information about the dialog, the last message, and the unread counter.

Parameters

Parameter Type Required Default Description
skipOpenLines string no Exclude Open Channels conversations. Accepts true, Y, or y
skipChat string no Exclude group chats. Accepts true, Y, or y
skipDialog string no Exclude private dialogs. Accepts true, Y, or y
unreadOnly string no Only dialogs with unread messages. Accepts true, Y, or y
onlyOpenLines string no Only Open Channels conversations. Accepts true, Y, or y
onlyCopilot string no Only chats with the AI assistant. Accepts true, Y, or y
onlyChannel string no Only channels. Accepts true, Y, or y
lastMessageDate string no Date of the last message for pagination (ISO 8601)
updatedAfter string no Delta mode: return dialogs changed starting from the given instant. Date in ISO 8601 with an explicit offset or Z. Not compatible with offset or lastMessageDate
limit number no 50 Number of items in the response. Maximum 200
offset number no 0 Offset for pagination

Delta mode. The updatedAfter parameter switches the endpoint into a "what changed since the given instant" mode: GET /v1/chats/recent?updatedAfter=2026-06-28T00:00:00Z. The response contains an array of dialogs whose dateUpdate is not earlier than the given instant. The boundary is inclusive — a dialog whose dateUpdate equals the given instant is included, so if you advance the cursor to the highest value you have seen, that boundary record arrives again on the next call.

The page size in this mode is controlled by the server: one page of up to 200 dialogs is read. The limit you pass does not affect it and is returned in meta.requestedLimit together with the applied meta.appliedLimit.

When meta contains truncated with the value true, the delta may be incomplete: Bitrix24 reported that more dialogs exist beyond the returned page, or the response shape could not be parsed. In that case do not move updatedAfter — read the full list using the paged mode with the lastMessageDate cursor. The number of rows returned is not a completeness signal — a short response also arrives when more data exists beyond it.

A date without an explicit offset — for example 2026-06-29 10:00:00 — is rejected with 400 INVALID_PARAMS: such a value reads differently depending on the server time zone, so the instant has to be stated unambiguously.

Examples

curl — personal key

Terminal
curl "https://vibecode.bitrix24.com/v1/chats/recent?limit=20" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal
curl "https://vibecode.bitrix24.com/v1/chats/recent?limit=20" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/chats/recent?limit=20', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Recent dialogs:', data.items)

JavaScript — OAuth application

javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/chats/recent?limit=20', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Response fields

Field Type Description
data object Result object
data.items array Array of recent dialogs
data.items[].id string Dialog identifier (chatXXX for a group chat or a numeric ID for a private dialog)
data.items[].chatId number Numeric chat ID
data.items[].type string Dialog type: chat, openlines, copilot, channel
data.items[].title string Dialog title
data.items[].avatar object Dialog avatar
data.items[].avatar.url string Avatar image URL. Empty string if the avatar is not set
data.items[].avatar.color string Avatar color in hexadecimal format, for example #4ba984
data.items[].message object Last message in the dialog
data.items[].message.id number Message ID
data.items[].message.text string Message text
data.items[].message.authorId number Message author ID
data.items[].message.date string Message date (ISO 8601)
data.items[].message.file boolean Whether the message contains a file
data.items[].message.attach boolean Whether the message contains an attachment
data.items[].message.sticker string | null Message sticker or null
data.items[].message.status string Message status (for example, received)
data.items[].lastId number ID of the last read message
data.items[].unread boolean Whether there are unread messages
data.items[].counter number Number of unread messages
data.items[].pinned boolean Dialog is pinned
data.items[].dateUpdate string Date of the last dialog update (ISO 8601)
data.items[].dateLastActivity string Date of the last activity (ISO 8601)
data.items[].chat object Extended chat information
data.items[].chat.id number Numeric chat ID
data.items[].chat.name string System chat name
data.items[].chat.type string Chat type: chat, general, openlines, copilot, channel, mail, crm, and others
data.items[].chat.owner number Chat owner ID
data.items[].chat.userCounter number Number of members
data.items[].chat.role string Role of the current user: OWNER, MANAGER, MEMBER
data.items[].chat.entityType string Type of the linked entity (CRM, TASKS, MAIL, GENERAL, and others)
data.items[].chat.entityId string ID of the linked entity
data.hasMorePages boolean true if there is a next page
data.hasMore boolean Duplicates hasMorePages. Kept for backward compatibility
meta.requestedLimit number The passed limit before clamping. Present together with appliedLimit only when the passed value falls outside the range from 1 to 200 or when limit is passed in delta mode
meta.appliedLimit number The limit value applied after clamping. In delta mode this is the server page size — 200, not a clamped limit
meta.mode string The value delta. Present only in delta mode
meta.returned number Number of dialogs in the response. Present only in delta mode
meta.truncated boolean Returned with the value true when the delta could not be confirmed complete: more dialogs exist beyond the returned page, or the response shape could not be parsed

In delta mode data is an array of dialogs with the same item fields listed above for data.items. The hasMorePages and hasMore fields are not returned in this mode — meta.truncated serves that role instead.

Response example

Paged mode:

JSON
{
  "success": true,
  "data": {
    "items": [
      {
        "id": "chat456",
        "chatId": 456,
        "type": "chat",
        "title": "Development team",
        "avatar": {
          "url": "",
          "color": "#4ba984"
        },
        "message": {
          "id": 1201,
          "text": "Task update is ready",
          "authorId": 1,
          "date": "2026-06-03T16:51:12+00:00",
          "file": false,
          "attach": false,
          "sticker": null,
          "status": "received"
        },
        "lastId": 1195,
        "pinned": false,
        "unread": false,
        "counter": 0,
        "dateUpdate": "2026-06-03T16:51:12+00:00",
        "dateLastActivity": "2026-06-03T16:51:12+00:00",
        "chat": {
          "id": 456,
          "name": "Development team",
          "type": "chat",
          "owner": 1,
          "userCounter": 5,
          "role": "OWNER",
          "entityType": "",
          "entityId": ""
        }
      },
      {
        "id": "chat123",
        "chatId": 123,
        "type": "crm",
        "title": "Deal chat",
        "avatar": {
          "url": "",
          "color": "#f76187"
        },
        "message": {
          "id": 980,
          "text": "Contract approved",
          "authorId": 7,
          "date": "2026-06-02T14:08:10+00:00",
          "file": false,
          "attach": false,
          "sticker": null,
          "status": "received"
        },
        "lastId": 0,
        "pinned": false,
        "unread": false,
        "counter": 0,
        "dateUpdate": "2026-06-02T14:08:10+00:00",
        "dateLastActivity": "2026-06-02T14:08:10+00:00",
        "chat": {
          "id": 123,
          "name": "Deal chat",
          "type": "crm",
          "owner": 1,
          "userCounter": 2,
          "role": "MEMBER",
          "entityType": "CRM",
          "entityId": "DEAL|42"
        }
      }
    ],
    "hasMorePages": true,
    "hasMore": true
  }
}

Delta mode. The main item fields are shown; the full set is in the table above:

JSON
{
  "success": true,
  "data": [
    {
      "id": "chat456",
      "chatId": 456,
      "type": "chat",
      "title": "Development team",
      "pinned": false,
      "unread": false,
      "counter": 0,
      "dateUpdate": "2026-06-29T10:12:44+00:00",
      "dateLastActivity": "2026-06-29T10:12:44+00:00"
    }
  ],
  "meta": {
    "mode": "delta",
    "returned": 1
  }
}

Error response example

403 — no im scope:

JSON
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'im' scope"
  }
}

Errors

HTTP Code Description
400 INVALID_PARAMS updatedAfter was passed without an explicit offset or Z, or is not a date
400 INVALID_PARAMS updatedAfter was passed together with offset or lastMessageDate
403 SCOPE_DENIED The API key does not have the im scope
401 TOKEN_MISSING The API key has no Bitrix24 tokens configured
422 BITRIX_ERROR Bitrix24 returned an error (details in message)
502 BITRIX_UNAVAILABLE Bitrix24 is unavailable or returned a server error

The full list of general API errors — Errors.

Known specifics

  • The skipOpenLines and onlyOpenLines flags are mutually exclusive: enabling both yields a result in which no Open Channels chat appears in the list.
  • Ordering between pages by offset is guaranteed while the window together with the headroom for under-hydrated rows fits inside one Bitrix24 page: a call returns at most 200 records and the headroom for under-hydrated rows is 10, so the boundary falls where offset plus page size stays at or below 190. Within that boundary Vibecode slices the window on its own side, so neighbouring pages neither overlap nor drop a dialog. Past that boundary the offset is forwarded to Bitrix24, where the list is rebuilt on every new message, and neighbouring pages may overlap or skip a dialog again.
  • The response contains a data.copilot field with the configuration of the Bitrix24 account's AI assistant. The structure is used to display roles in the Bitrix24 interface and is not part of the list of dialogs.
  • In delta mode a dialog whose dateUpdate cannot be read stays in the response: an extra record is safer than a lost change.
  • The skip*, only*, and unreadOnly filter families apply in delta mode as well, narrowing the page that is scanned.

See also