## Поиск сотрудников портала

`POST /v1/mail/recipients/employees`

Ищет сотрудников портала Битрикс24 для подстановки в поле получателей письма. При отсутствии совпадений возвращается пустой массив `items`.

## Поля запроса (body)

| Поле | Тип | Обяз. | Описание |
|------|-----|:-----:|----------|
| `query` | string | **да** | Строка поиска по имени или адресу электронной почты сотрудника. Минимум 1 символ |

## Примеры

### curl — личный ключ

```bash
curl -X POST \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "Мен"}' \
  https://vibecode.bitrix24.tech/v1/mail/recipients/employees
```

### curl — OAuth-приложение

```bash
curl -X POST \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query": "Мен"}' \
  https://vibecode.bitrix24.tech/v1/mail/recipients/employees
```

### JavaScript — личный ключ

```javascript
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/mail/recipients/employees',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ query: 'Мен' }),
  }
)
const body = await res.json()
if (!body.success) throw new Error(body.error.code)
console.log(body.data.items)
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/mail/recipients/employees',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ query: 'Мен' }),
  }
)
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|----------|
| `success` | boolean | `true` при успешном выполнении |
| `data.items` | array | Массив найденных сотрудников. Пустой массив при отсутствии совпадений |
| `data.items[].id` | number | Идентификатор сотрудника |
| `data.items[].email` | string | Адрес электронной почты |
| `data.items[].name` | string | Отображаемое имя сотрудника |

## Пример ответа

```json
{
  "success": true,
  "data": {
    "items": [
      { "id": 1, "email": "manager@example.com", "name": "Менеджер" }
    ]
  }
}
```

## Пример ответа при ошибке

400 — не передан обязательный `query`:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Ошибка при валидации объекта запроса",
    "validation": [
      {
        "field": "MISSING_QUERY",
        "message": "Parameter \"query\" is required."
      }
    ]
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | Не передан или пустой `query` — `validation[].field` равен `MISSING_QUERY` |
| 422 | `BITRIX_ERROR` | Прочие ошибки Битрикс24 |
| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `mail` |
| 401 | `TOKEN_MISSING` | Ключ не привязан к порталу Битрикс24 |
| 429 | `RATE_LIMITED` | Превышен лимит запросов |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `INVALID_API_KEY` | Неверный или просроченный ключ |
| 401 | `KEY_INACTIVE` | Ключ деактивирован |
| 401 | `KEY_EXPIRED` | Срок действия ключа истёк |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Смотрите также

- [Поиск контактов CRM](./contacts.md)
- [Получатели](/docs/mail/recipients)
- [Почта](/docs/mail)
- [Отправить письмо](/docs/mail/messages/send)
- [Ключи и авторизация](/docs/keys-auth)
- [Ошибки](/docs/errors)