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

# Получить архивный состав и найти снятого сотрудника

> Возвращает страницу архивного состава выбранного сервера.

Возвращает страницу архивного состава выбранного сервера. Требуется personnel:archive\_read. Можно искать по тем же идентификаторам, что и текущий состав. Без by и value возвращается общий архив. Для продолжения используйте next\_cursor.

## Доступ

`personnel:archive_read`.

**Authorization** `string` *required*

Партнёрский Bearer-токен. Подробнее в разделе [«Авторизация»](https://docs.arzguard.com/cerberus-crm/authentication.md).

## Параметры

### Тело запроса

Передайте JSON с заголовком `Content-Type: application/json`.

**moderator** `object` *required*

Модератор, который инициировал действие через бота. CRM определяет его аккаунт по привязанному внешнему ID и проверяет полномочия.

**Поля**

**platform\_user\_id** `string` *required*

ID модератора на выбранной платформе, строкой. Это ID пользователя, а не имя или ID бота. До 20 символов.

**provider** `string` *required*

Платформа модератора: discord — Discord, telegram — Telegram. Допустимые значения `discord`, `telegram`.

**query** `object` *required*

**Поля**

**by** `string`

Тип поиска: discord\_id — ID Discord. Telegram\_id — ID Telegram. Forum\_id — числовой ID форума. Forum\_url — ссылка на профиль форума. Internal\_id — UUID пользователя или записи состава. Nickname — имя сотрудника в CRM. Допустимые значения `discord_id`, `telegram_id`, `forum_id`, `forum_url`, `internal_id`, `nickname`.

**cursor** `string`

Курсор из next\_cursor предыдущей страницы. В первом запросе не передавайте. До 36 символов.

**limit** `integer`

Максимальное число записей в одной странице. По умолчанию `25`. Диапазон от `1` до `100`.

**server\_id** `string | integer` *required*

Уникальный номер сервера из GET /api/partner/v1/servers или UUID сервера. Сервер должен входить в выданный боту доступ.

**value** `string`

Значение, вызвавшее ошибку. До 2048 символов.

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

HTTP `200`. Запрос выполнен успешно.

**members** `object[] | null` *required*

Сотрудники текущей страницы состава.

**Поля**

**display\_name** `string` *required*

Отображаемое имя сотрудника.

**id** `string` *required*

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

**position\_name** `string | null` *required*

Название должности сотрудника.

**status** `string` *required*

Текущее состояние записи.

**user\_id** `string | null` *required*

Идентификатор зарегистрированного пользователя CRM. Null, если аккаунт ещё не зарегистрирован.

**next\_cursor** `string`

Курсор следующей страницы. Пустое значение или отсутствие поля означает, что следующей страницы нет.

## Ошибки

| HTTP | Значение |
| - | - |
| `400` | Некорректные параметры запроса. |
| `401` | Токен отсутствует, недействителен, отозван или не разрешён для этого IP-адреса. |
| `403` | Недостаточно прав у бота или указанного модератора; сервер или функция не входят в выданный доступ. |
| `404` | Запись не найдена или недоступна в данном контексте. |
| `409` | Конфликт состояния или ключа идемпотентности. Получите актуальную ревизию перед новым действием. |
| `422` | Данные не прошли проверку формата или ограничений. Подробности находятся в поле errors. |
| `429` | Превышен лимит запросов. Дождитесь интервала, указанного в заголовке Retry-After. |
| `500` | Внутренняя ошибка сервера. |
| `503` | Сервис временно недоступен. Повторите запрос позднее. |

См. [формат ошибок и правила повторов](https://docs.arzguard.com/cerberus-crm/requests-and-errors.md).

## Пример

В примере использованы условные идентификаторы.

```bash cURL theme={null}
curl --request POST \
  --header "Authorization: Bearer $PARTNER_TOKEN" \
  --header 'Content-Type: application/json' \
  --data-binary '{
  "moderator": {
    "provider": "discord",
    "platform_user_id": "123456789012345678"
  },
  "query": {
    "server_id": 102,
    "limit": 25
  }
}' \
  'https://test.crm.arzguard.com/api/partner/v1/personnel/archive'
```

```json HTTP 200, сокращённый ответ theme={null}
{
  "members": []
}
```


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