## Получить личные закреплённые сообщения

`GET /v1/chats/:dialogId/pins/personal`

Возвращает постранично сообщения, которые текущий пользователь закрепил для себя в одном чате.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|-----------|------|----------|-------------|
| `dialogId` (path) | string | да | `chat` и реальный ID чата из [загрузки чата](/docs/chats/messages/load), в том числе личного. Числовой ID собеседника и `me` отклоняются |
| `limit` (query) | integer | нет | Строк на страницу: 1–200, по умолчанию 50. Выход за границы ограничивается с отражением в `meta.requestedLimit` и `meta.appliedLimit` |
| `lastId` (query) | integer | нет | Исключающий курсор: `messageId` последней строки предыдущей страницы |
| `order` (query) | string | нет | `desc` по умолчанию либо `asc` |

Нужен скоуп `im`. Текущий пользователь определяется по токенам авторизации. Параметры выбора владельца и неизвестные параметры отклоняются. Если чат разрешает автовступление, чтение может добавить пользователя в участники.

## Примеры

### curl — личный ключ

```bash
curl -X GET "https://vibecode.bitrix24.tech/v1/chats/chat1945/pins/personal" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth-приложение

```bash
curl -X GET "https://vibecode.bitrix24.tech/v1/chats/chat1945/pins/personal" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat1945/pins/personal', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const { data } = await res.json()
console.log(data)
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat1945/pins/personal', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()
console.log(data)
```

## Поля ответа

| Поле | Тип | Описание |
|-------|------|-------------|
| `success` | boolean | `true` |
| `data.personalPins` | array | Строки личных закрепов |
| `data.personalPins[].id` | number | ID строки закрепа |
| `data.personalPins[].messageId` | number | ID сообщения и курсор следующей страницы |
| `data.personalPins[].chatId` | number | Реальный ID чата |
| `data.personalPins[].authorId` | number | ID владельца закрепа |
| `data.personalPins[].dateCreate` | string | Дата закрепления |
| `data.hasNextPage` | boolean | Есть ли следующая страница |
| `data.messages, data.additionalMessages` | array | Закреплённые сообщения: `id`, `chatId`, `authorId`, `date`, `text`, `isSystem`. Каждое из двух полей приходит не в каждом ответе |
| `data.users` | array | Связанные пользователи |
| `data.files, data.reactions, data.stickers` | array | Файлы, реакции и стикеры закреплённых сообщений. Приходят не в каждом ответе: в пустой выдаче их нет |
| `data.tariffRestrictions.isHistoryLimitExceeded` | boolean | `true`, когда тариф скрывает часть старой истории чата и её сообщения не попадают в выдачу |
| `meta.requestedLimit` | number | Переданный `limit`. Приходит вместе с `appliedLimit`, только когда значение вышло за диапазон от 1 до 200 |
| `meta.appliedLimit` | number | Применённое значение `limit` — только если оно было приведено к границе |

## Пример ответа

Показаны основные поля сообщений и пользователя.

```json
{
  "success": true,
  "data": {
    "personalPins": [
      {
        "id": 12,
        "messageId": 846,
        "chatId": 1945,
        "authorId": 7,
        "dateCreate": "2026-11-17T10:05:00+03:00"
      },
      {
        "id": 11,
        "messageId": 845,
        "chatId": 1945,
        "authorId": 7,
        "dateCreate": "2026-11-17T10:04:00+03:00"
      }
    ],
    "additionalMessages": [
      {"id": 846, "chatId": 1945, "authorId": 12, "date": "2026-11-16T09:30:00+03:00", "text": "Release notes are ready", "isSystem": false},
      {"id": 845, "chatId": 1945, "authorId": 12, "date": "2026-11-16T09:28:00+03:00", "text": "Project update", "isSystem": false}
    ],
    "users": [{"id": 12, "active": true, "name": "Anna Smith", "type": "user"}],
    "files": [],
    "reactions": [],
    "stickers": [],
    "tariffRestrictions": {"isHistoryLimitExceeded": false},
    "hasNextPage": false
  }
}
```

## Пример ответа при ошибке

400 — передан неизвестный параметр:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Query parameter `ownerId` is not accepted by GET /v1/chats/:dialogId/pins/personal. Accepted: lastId, order, limit."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | Некорректный ID, неизвестный или повторный параметр либо поле тела |
| 422 | `BITRIX_ERROR` | `error.b24Code` равен `CHAT_NOT_FOUND` — чата с таким ID нет |
| 401 | `MISSING_API_KEY` | Не передан API-ключ |
| 401 | `TOKEN_MISSING` | Нет настроенных токенов Битрикс24 |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `im` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ в режиме `READONLY` не является обычным личным ключом сотрудника: это ключ приложения с пользовательской сессией, ключ управления или ключ неподтверждённого типа. Проверяется до обращения к Битрикс24 |
| 403 | `BITRIX_ACCESS_DENIED` | У текущего пользователя нет доступа |
| 404 | `ENTITY_NOT_FOUND` | Запись не найдена |
| 422 | `BITRIX_ERROR` | Битрикс24 отклонил операцию с другим кодом, он — в `error.b24Code` |

Общие ошибки API — [Ошибки](/docs/errors).

## Известные особенности

При [полной загрузке чата](/docs/chats/messages/load) начальный блок личных закрепов приходит в объекте `data`: `personalPins` и `personalPinsHasNextPage`. Этот метод нужен для постраничного чтения. Если при полной загрузке блока нет, возможность не поддерживается. Пустой список передаётся как `personalPins: []`.

## Смотрите также

- [Конфигурация чата](/docs/chats/discovery/configuration)
- [Сообщения](/docs/chats/messages)
