> ## 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:blacklist_read`. Для глобального списка дополнительно требуется `personnel:blacklist_global`.

**Authorization** `string` *required*

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

## Параметры

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

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

**cursor** `string`

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

Формат `uuid`.

**moderator** `object` *required*

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

**Поля**

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

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

**provider** `string` *required*

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

**scope** `string` *required*

Область чёрного списка: local — выбранный сервер, global — весь проект. Для global необходимо отдельное глобальное право. Допустимые значения `local`, `global`.

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

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

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

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

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

Записи текущей страницы.

**Поля**

**created\_at** `string` *required*

Дата и время создания записи.

Формат `date-time`.

**expires\_at** `string | null` *required*

Дата и время окончания действия. Null для бессрочной записи.

Формат `date-time`.

**id** `string` *required*

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

Формат `uuid`.

**reason** `string` *required*

Причина действия или записи.

**server\_id** `string` *required*

Идентификатор сервера CRM (UUID). Сервер должен входить в выданный боту доступ.

Формат `uuid`.

**status** `string` *required*

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

**target\_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"
  },
  "scope": "local",
  "server_id": 102
}' \
  'https://test.crm.arzguard.com/api/partner/v1/personnel/blacklist/list'
```

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


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