For AI agents: markdown of this page — /docs-content-en/userfields/crm/types.md documentation index — /llms.txt

Field type catalog

GET /v1/userfields/:entity/types

Returns the list of available user field types. The list is the same for all CRM entities and for smart processes.

Parameters

Parameter Type Required Description
Parameter:entity (path) Typestring Requiredyes DescriptionEntity: deals, leads, contacts, companies, quotes, requisites. The value does not affect the result — it is used only to verify scope presence.

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/userfields/deals/types" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/userfields/deals/types" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.com/v1/userfields/deals/types',
  {
    headers: { 'X-Api-Key': 'YOUR_API_KEY' },
  }
)
const { success, data } = await res.json()
console.log(`Types available: ${data.length}`)

JavaScript — OAuth application

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.com/v1/userfields/deals/types',
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)
const { success, data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of field type objects
Fielddata[].ID Typestring DescriptionType identifier — used as userTypeId in creation and filter requests
Fielddata[].title Typestring DescriptionDisplay name of the type

Full list of types from the API response:

ID title
IDstring titleString
IDinteger titleInteger
IDdouble titleNumber
IDboolean titleYes/No
IDenumeration titleList
IDdatetime titleDate/Time
IDdate titleDate
IDmoney titleMoney
IDurl titleLink
IDaddress titleGoogle Map address
IDfile titleFile
IDemployee titleLink to a user
IDcrm_status titleLink to CRM directories
IDiblock_section titleLink to information block sections
IDiblock_element titleLink to information block elements
IDcrm titleLink to CRM items

Response example

JSON 
{
  "success": true,
  "data": [
    { "ID": "string", "title": "String" },
    { "ID": "integer", "title": "Integer" },
    { "ID": "double", "title": "Number" },
    { "ID": "boolean", "title": "Yes/No" },
    { "ID": "enumeration", "title": "List" },
    { "ID": "datetime", "title": "Date/Time" },
    { "ID": "date", "title": "Date" },
    { "ID": "money", "title": "Money" },
    { "ID": "url", "title": "Link" },
    { "ID": "address", "title": "Google Map address" },
    { "ID": "file", "title": "File" },
    { "ID": "employee", "title": "Link to a user" },
    { "ID": "crm_status", "title": "Link to CRM directories" },
    { "ID": "iblock_section", "title": "Link to information block sections" },
    { "ID": "iblock_element", "title": "Link to information block elements" },
    { "ID": "crm", "title": "Link to CRM items" }
  ]
}

Error response example

400 — unknown entity:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_ENTITY",
    "message": "Unsupported entity \"foobar\". Supported: deals, leads, contacts, companies, quotes, requisites"
  }
}

Errors

HTTP Code Description
HTTP400 CodeUNKNOWN_ENTITY Description:entity is not in the list of supported entities
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the crm scope

Full list of common API errors — Errors.

Known specifics

Same result for all entities. You can call it with any valid :entity — the response will be identical. The :entity value affects only the scope check.

System types in fields. The response of GET /v1/userfields/:entity may contain fields with a userTypeId that is absent from this catalog — for example resourcebooking. These are types that Bitrix24 creates for internal needs.

See also