> ## 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.

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

> Возвращает сведения о переписке и при необходимости страницу её сообщений.

Возвращает сведения о переписке и при необходимости страницу её сообщений.

Поля `messages` и `pagination` добавляются только при `with_messages=1`. Получение переписки не заменяет явную отметку прочтения через POST-метод.

## Доступ

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

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

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

## Параметры

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

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

**id** `integer` *required*

Идентификатор переписки.

**with\_messages** `boolean`

При `1` добавляет страницу сообщений и объект `pagination` к сведениям о переписке.

**page** `integer`

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

## Ответ

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

**conversation** `Conversation`

Сведения о переписке с учётом текущего участника.

**messages** `ConversationMessage[]`

Массив сообщений запрошенной страницы. Возвращается только при `with_messages=1`.

**pagination** `pagination`

Сведения о странице: `current_page`, `last_page`, `per_page`, `shown`, `total`. Возвращается только при `with_messages=1`.

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

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

```json 200 · условный пример theme={null}
{
  "conversation": {
    "conversation_id": 123,
    "title": "Пример переписки"
  }
}
```

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


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