> ## 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`. Примеры используют серверную переменную `$FORUM_API_KEY`; [тип ключа и контекст пользователя](https://docs.arzguard.com/guard-forum/authentication.md) определяют доступ к данным.

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

Ключ API. Храните его на сервере интеграции; в примере используется переменная окружения.

Обязательные scopes: `profile_post:read`.

## Параметры

**id** `integer` *required*

ID записи профиля. Значение `123` в примере условное.

**with\_comments** `boolean`

При `1` добавляет страницу комментариев к записи профиля.

**page** `integer`

Номер страницы комментариев при `with_comments=1`.

**direction** `string`

Порядок комментариев: `desc` — сначала новые (по умолчанию), `asc` — сначала старые.

## Успешный ответ

HTTP `200`. Пример ниже сокращён и содержит только условные данные. Полные объекты и условия видимости полей описаны в [схемах данных](https://docs.arzguard.com/guard-forum/models.md).

| Поле | Тип | Описание |
| - | - | - |
| `profile_post` | `ProfilePost` | Объект записи профиля `ProfilePost`. |
| `comments` | `ProfilePostComment[]` | Комментарии выбранной страницы. Возвращается только при `with_comments=1`. |
| `pagination` | `pagination` | Метаданные страницы: `current_page`, `last_page`, `per_page`, `shown`, `total`. Размер страницы определяется настройками форума. Возвращается только при `with_comments=1`. |

## Ошибки

Стандартный ответ содержит массив `errors` с `code`, `message` и `params`. Проверяйте HTTP-статус и машинный код; [формат и обработка ошибок](https://docs.arzguard.com/guard-forum/requests-and-errors.md) общие для API.

```bash cURL theme={null}
curl --request GET \
  --header "XF-Api-Key: $FORUM_API_KEY" \
  --header 'Accept: application/json' \
  'https://forum.arzguard.com/api/profile-posts/123/?with_comments=1&page=1'
```

```json Сокращённый условный ответ theme={null}
{
  "profile_post": {
    "profile_post_id": 123
  },
  "comments": [
    {
      "profile_post_comment_id": 123
    }
  ],
  "pagination": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 20,
    "shown": 1,
    "total": 1
  }
}
```


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