Get a list of custom field types crm.userfield.types
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: any user
The method crm.userfield.types retrieves the available types of custom fields.
The types returned are:
string— stringinteger— integerdouble— numberboolean— yes/nodatetime— date and timeenumeration— listiblock_section— binding to information block sectionsiblock_element— binding to information block elementsemployee— binding to an employeecrm_status— binding to the CRM directorycrm— binding to CRM entitiesaddress— Google Maps addressmoney— moneyurl— link
The method also returns custom types registered by the current application.
Method Parameters
No parameters.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.userfield.types
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.userfield.types
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each item returned in result[]
type UserfieldTypeItem = {
ID: string
title: string
}
try {
const response = await $b24.actions.v2.call.make<UserfieldTypeItem[]>({
method: 'crm.userfield.types',
params: {},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Field types:', result.length, result.map(t => t.ID))
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getUserfieldTypes() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.userfield.types',
params: {},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Field types:', result.length, result.map(t => t.ID))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getUserfieldTypes)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.userfield.types().response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'crm.userfield.types',
[]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
"crm.userfield.types",
{},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.userfield.types',
[]
);
print_r($result);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.userfield.types", nil)
if err != nil {
return fmt.Errorf("crm.userfield.types: %w", err)
}
var items []struct {
ID string `json:"ID"`
Title string `json:"title"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Title)
}
Response Handling
HTTP status: 200
{
"result": [
{
"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 Maps Address"
},
{
"ID": "file",
"title": "File"
},
{
"ID": "employee",
"title": "Binding to User"
},
{
"ID": "crm_status",
"title": "Binding to CRM Directories"
},
{
"ID": "iblock_section",
"title": "Binding to Information Block Sections"
},
{
"ID": "iblock_element",
"title": "Binding to Information Block Elements"
},
{
"ID": "crm",
"title": "Binding to CRM Entities"
}
],
"time": {
"start": 1773992560,
"finish": 1773992560.044522,
"duration": 0.04452204704284668,
"processing": 0,
"date_start": "2026-03-20T10:42:40+02:00",
"date_finish": "2026-03-20T10:42:40+02:00",
"operating_reset_at": 1773993160,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Array of objects with supported types (detailed description) |
|
time |
Information about the request execution time |
Result Object
|
Name |
Description |
|
ID |
Code of the custom field type |
|
title |
Name of the custom field type |
Error Handling
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |