Для AI-агентов: markdown этой страницы — /docs-content/userfields/types.md индекс документации — /llms.txt

Типы пользовательских полей модуля

GET /v1/userfields/types?moduleId=crm

Возвращает только userTypeId и description, без внутренних ключей PHP. Ключ должен иметь скоуп, совпадающий с moduleId. Для смарт-процессов укажите crm. Модуль main отвечает No settings for UserFieldAccess: типы полей сотрудников недоступны.

Параметры

Параметр Тип Обяз. Описание
moduleId (query) string да Идентификатор модуля, например crm. Нужен тот же скоуп у ключа.

Примеры

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

Terminal 

curl "https://vibecode.bitrix24.tech/v1/userfields/types?moduleId=crm" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 

curl "https://vibecode.bitrix24.tech/v1/userfields/types?moduleId=crm" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 

const response = await fetch('https://vibecode.bitrix24.tech/v1/userfields/types?moduleId=crm', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)

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

javascript 

const response = await fetch('https://vibecode.bitrix24.tech/v1/userfields/types?moduleId=crm', {
  headers: { 'X-Api-Key': 'YOUR_APP_KEY', Authorization: 'Bearer USER_SESSION_TOKEN' },
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)

Поля ответа

Поле Тип Описание
success boolean true
data array Доступные типы полей.
data[].userTypeId string Идентификатор типа для создания поля.
data[].description string Описание на языке аккаунта Битрикс24.
JSON 

{
  "success": true,
  "data": [
    {
      "userTypeId": "string",
      "description": "Строка"
    }
  ]
}

422 — для main нет настроек типов:

JSON 

{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "No settings for UserFieldAccess"
  }
}

Ошибки

HTTP Code Условие
400 INVALID_PARAMS Нет moduleId или неверная форма.
401 MISSING_API_KEY Нет ключа.
403 SCOPE_DENIED Нет скоупа запрошенного модуля.
403 BITRIX_ACCESS_DENIED Битрикс24 отказал в доступе.
422 BITRIX_ERROR Нет настроек типов модуля или другой бизнес-отказ.

Все ошибки

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