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

GET /v1/users/fields

Возвращает полный список полей сущности «сотрудник», включая пользовательские (UF_*) поля портала.

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/users/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/users/fields" \
  -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/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Полей:', Object.keys(data.fields).length)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/users/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

#Поля ответа

Поле Bitrix24 Тип RO Описание
id ID number да Идентификатор сотрудника
name NAME string Имя
lastName LAST_NAME string Фамилия
secondName SECOND_NAME string Отчество
email EMAIL string Email — обязательное при создании, должно быть уникальным
active ACTIVE boolean Признак активности (true — работает, false — деактивирован)
workPosition WORK_POSITION string Должность
workPhone WORK_PHONE string Рабочий телефон
personalPhone PERSONAL_PHONE string Личный телефон
personalMobile PERSONAL_MOBILE string Мобильный телефон
personalBirthday PERSONAL_BIRTHDAY string Дата рождения (формат ISO 8601)
personalGender PERSONAL_GENDER string Пол: M — мужской, F — женский
personalCity PERSONAL_CITY string Город
personalPhoto PERSONAL_PHOTO string URL фотографии
departmentId UF_DEPARTMENT number[] Массив ID отделов. Список: GET /v1/departments
xmlId XML_ID string Внешний идентификатор для интеграций
isAdmin IS_ADMIN boolean да Признак администратора портала
isOnline IS_ONLINE boolean да Сотрудник сейчас в сети
dateRegister DATE_REGISTER datetime да Дата регистрации в портале
lastLogin LAST_LOGIN datetime да Дата последнего входа
lastActivityDate LAST_ACTIVITY_DATE datetime да Дата последней активности

Пользовательские поля (UF_*) также возвращаются в ответах и принимаются при создании или обновлении.

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "name": { "type": "string", "readonly": false },
      "lastName": { "type": "string", "readonly": false },
      "email": { "type": "string", "readonly": false },
      "active": { "type": "boolean", "readonly": false },
      "workPosition": { "type": "string", "readonly": false },
      "departmentId": { "type": "array", "readonly": false },
      "personalPhone": { "type": "string", "readonly": false },
      "isAdmin": { "type": "boolean", "readonly": true },
      "lastLogin": { "type": "datetime", "readonly": true },
      "ID": { "type": "string", "readonly": false, "label": "ID" },
      "NAME": { "type": "string", "readonly": false, "label": "Имя" },
      "ACTIVE": { "type": "string", "readonly": false, "label": "ACTIVE" },
      "UF_DEPARTMENT": { "type": "string", "readonly": false, "label": "Отдел" },
      "UF_PHONE_INNER": { "type": "string", "readonly": false, "label": "UF_PHONE_INNER" }
    },
    "batch": ["create", "update", "delete"]
  }
}

Показаны несколько полей из общего списка. Реальный ответ возвращает 20+ полей схемы в camelCase и 30+ оригинальных имён в UPPER_SNAKE_CASE, включая UF-поля конкретного портала.

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

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

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

#Ошибки

HTTP Код Описание
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
403 SCOPE_DENIED API-ключ не имеет скоупа user

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

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