> ## 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: `attachment:read`. Все перечисленные разрешения нужны одновременно.

Права текущего API-пользователя проверяются отдельно от scopes. Для Super key контекст задаётся заголовком `XF-Api-User`.

## Параметры

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

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

**id** `integer` *required*

Идентификатор вложения.

**key** `string`

Секретный ключ набора временных вложений, полученный через `POST /attachments/new-key`. Это не API-ключ из заголовка.

**hash** `string`

Секретный временный hash вложения. Для ещё не привязанного файла нужен подходящий `hash` либо `key`; после привязки проверяются права на содержимое.

Для временного вложения передайте секретный `key` либо `hash` в query. Для уже прикреплённого файла эти значения не заменяют права на его содержимое.

## Ответ

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

**attachment** `Attachment`

Описание доступного вложения.

Ошибки возвращаются в общей структуре `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/attachments/123/' \
  --header "XF-Api-Key: $FORUM_API_KEY"
```

```json 200 · условный пример theme={null}
{
  "attachment": {
    "attachment_id": 123,
    "filename": "example.txt"
  }
}
```

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


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