Список сотрудников

GET /v1/users

Возвращает список сотрудников портала с поддержкой фильтрации, сортировки и автопагинации. Метод не возвращает ботов, почтовых пользователей и пользователей Открытых линий.

Параметры

Параметр Тип По умолч. Описание
limit number 50 Количество записей (до 5000). При limit > 50 Вайбкод автоматически запрашивает несколько страниц у Битрикс24
offset number 0 Пропустить N записей. При offset > 0 рекомендуется limit ≤ 500
order object — Сортировка по любому полю записи. Пример: ?order[name]=asc
filter object — Фильтрация по полям GET /v1/users/fields.
Синтаксис фильтрации. Пример: ?filter[name]=Иван

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/users?limit=10&filter[active]=true" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/users?limit=10&filter[active]=true" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/users?limit=10&filter[active]=true', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, total } = await res.json()
console.log(`Найдено ${total} сотрудников`)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/users?limit=10&filter[active]=true', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив сотрудников. Каждый элемент содержит все поля — см. Поля сотрудника
total number Общее количество записей под фильтр
page number Текущая страница
limit number Размер страницы

URL карточки любого сотрудника из массива data — его id:

https://<portal>.bitrix24.ru/company/personal/user/<id>/

<portal> — домен портала. Доступ ограничен правами сотрудника в Битрикс24.

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "xmlId": "28889266",
      "active": true,
      "name": "Мария",
      "lastName": null,
      "secondName": "Отчество",
      "email": "maria@example.com",
      "lastLogin": "2026-05-05T08:25:11.000Z",
      "dateRegister": "2020-04-20T00:00:00.000Z",
      "timeZone": "Europe/Kaliningrad",
      "isOnline": false,
      "timestampX": {},
      "lastActivityDate": {},
      "personalGender": "F",
      "personalPhoto": "https://cdn-ru.bitrix24.ru/.../photo.jpg",
      "personalMobile": "+79991234567",
      "workPosition": null,
      "departmentId": [1, 107, 47],
      "userType": "employee"
    },
    {
      "id": 29,
      "xmlId": "28936832",
      "active": true,
      "name": "Иван",
      "lastName": "Петров",
      "email": "ivan.petrov@example.com",
      "departmentId": [1],
      "userType": "employee"
    }
  ],
  "total": 30,
  "page": 1,
  "limit": 10
}

Показаны основные поля. Полный список — Поля сотрудника.

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

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]. active: true исключает деактивированных. active: false Битрикс24 не интерпретирует как «только деактивированные» — возвращаются все. Чтобы получить только деактивированных, просеивайте результат на стороне клиента по полю active.

Поля WORK_* и часть полей PERSONAL_* приходят в UPPER_SNAKE_CASE. WORK_COMPANY, WORK_DEPARTMENT, WORK_WWW, WORK_FAX, WORK_CITY, WORK_STATE, WORK_ZIP, WORK_COUNTRY и аналогичные; PERSONAL_STATE, PERSONAL_ZIP, PERSONAL_COUNTRY, PERSONAL_MAILBOX, PERSONAL_NOTES — в оригинальных именах Битрикс24. UF-поля портала тоже сохраняют свои имена. Стандартные поля (name, email, active, timeZone, userType, departmentId и др.) — camelCase.

Поле lastActivityDate (объявлено datetime). На практике приходит пустым объектом {}, либо ключ отсутствует вовсе — ISO-строка по этому полю в проверках не наблюдалась. {} — истинное значение в JS, поэтому if (u.lastActivityDate) ложно-срабатывает. То же у timestampX (всегда {}). Не парсьте как дату и не полагайтесь на truthy-проверку; сравнивайте тип (typeof x === 'string'). См. сводку по «пусто» в datetime-полях в обзоре сущности (п. 7).

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