> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arzguard.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Получить список переписок

> Возвращает личные переписки текущего пользователя с фильтрами и пагинацией.

Возвращает личные переписки текущего пользователя с фильтрами и пагинацией.

## Доступ

Передавайте `XF-Api-Key` в заголовке каждого запроса. [Типы ключей и выбор пользователя](https://docs.arzguard.com/guard-forum/authentication.md).

Требуемые scopes: `conversation:read`. Все перечисленные разрешения нужны одновременно.

Нужен контекст зарегистрированного пользователя. Для Super key укажите `XF-Api-User`; доступ к объектам и действиям проверяется отдельно от scopes.

## Параметры

**XF-Api-Key** `string` *required*

Секретный API-ключ. В примерах ключ берётся из серверной переменной `$FORUM_API_KEY`.

**page** `integer`

Номер страницы. Размер страницы задаётся настройками форума; отдельного параметра `per_page` у этого метода нет.

**starter\_id** `integer`

Оставить переписки, созданные пользователем с этим ID.

**receiver\_id** `integer`

Оставить переписки с указанным получателем.

**starred** `boolean`

При `1` возвращать только переписки, отмеченные избранными.

**unread** `boolean`

При `1` оставляет только непрочитанные элементы. Просмотр уведомления и прочтение связанного содержимого — разные состояния.

## Ответ

HTTP `200`, JSON. [Схемы объектов и условные поля](https://docs.arzguard.com/guard-forum/models.md).

**conversations** `Conversation[]`

Массив переписок текущего пользователя.

**pagination** `pagination`

Сведения о странице: `current_page`, `last_page`, `per_page`, `shown`, `total`.

У пустого набора `shown=0`, `total=0`, а `current_page` и `last_page` могут быть `0`. Не считайте `1` минимально возможным значением этих двух полей. Подробнее: [пагинация и ошибки страниц](https://docs.arzguard.com/guard-forum/requests-and-errors.md).

Ошибки возвращаются в общей структуре `errors`. Обрабатывайте поле `code`; текст `message` может меняться или переводиться. [Формат ошибок](https://docs.arzguard.com/guard-forum/requests-and-errors.md).

```bash cURL theme={null}
curl --request GET 'https://forum.arzguard.com/api/conversations/' \
  --header "XF-Api-Key: $FORUM_API_KEY" \
  --get \
  --data-urlencode 'page=1'
```

```json 200 · условный пример theme={null}
{
  "conversations": [],
  "pagination": {
    "current_page": 0,
    "last_page": 0,
    "per_page": 20,
    "shown": 0,
    "total": 0
  }
}
```

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.