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

POST /v1/users/search

Поиск сотрудников с фильтрами в теле запроса и автопагинацией. Аналогичен `GET /v1/users`, но через POST — удобнее для сложных запросов и больших массивов значений в фильтре.

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

Параметр Тип По умолч. Описание
filter object — Фильтрация по полям GET /v1/users/fields.
Синтаксис фильтрации. Пример: { "filter": { "active": true, "lastName": "Иванов" } }
limit number 50 Количество записей (до 5000)
offset number 0 Пропустить N записей
order object — Сортировка: { "NAME": "asc" }

#Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/users/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "active": true },
    "limit": 10
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/users/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "active": true },
    "limit": 10
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/users/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { active: true },
    limit: 10,
  }),
})

const { success, data } = await res.json()
console.log('Найдено:', data.length)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/users/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { active: true },
    limit: 10,
  }),
})

const { success, data } = await res.json()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив сотрудников. Каждый элемент содержит все поля — см. Поля сотрудника

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "active": true,
      "name": "Летта",
      "lastName": null,
      "email": "kalashnikova@bitrix.ru",
      "departmentId": [1, 107, 47]
    },
    {
      "id": 29,
      "active": true,
      "name": "Violetta",
      "lastName": "Веточкина",
      "email": "violetwandere@yandex.ru",
      "departmentId": [1]
    }
  ]
}

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

403 — нет скоупа:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'user' scope"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_FILTER_FIELD Фильтр по несуществующему полю — список полей в GET /v1/users/fields
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
403 SCOPE_DENIED API-ключ не имеет скоупа user

Полный список общих ошибок API — Ошибки.

#Известные особенности

Семантика filter[active]: false. Возвращает всех сотрудников, а не только деактивированных — Битрикс24 интерпретирует ACTIVE = "Y" как «исключить деактивированных», а другие значения как «без фильтра по статусу». Чтобы получить только деактивированных, делайте отдельную фильтрацию на стороне клиента по полю active.

Когда использовать search вместо list. POST-search удобнее для длинных списков значений в фильтре ({ "id": [1, 5, 12, 27, 99] }) — query-строка GET-запроса имеет ограничения на длину, а body POST — нет. Для коротких фильтров обе формы эквивалентны.

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