Get Field Descriptions v 3.0 crm.[type].field.list
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: a user with permission to read items of this CRM object type
This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The crm.<type>.field.list method returns a list of available fields of a CRM object type with their attributes: whether a field can be edited, used for filtering, and used for sorting. The object type is set by the <type> segment of the method name.
The response includes standard fields, related objects, for example, assignedBy, and custom fields together with their paired UF_CRM_…_data fields. The set of fields depends on the object type and, for an SPA, also on the type settings: the fields that each setting adds are shown on the SPA fields page. Field descriptions with sample values are given on the field pages linked in the table below.
Method Name for the Object Type
|
Object type |
Method |
Fields |
|
Deal |
|
|
|
Lead |
|
|
|
Contact |
|
|
|
Company |
|
|
|
Estimate |
|
|
|
Invoice |
|
|
|
My company |
|
|
|
SPA |
|
For an SPA, the method name includes the type ID entityTypeId. SPA type IDs are returned by the crm.type.list method in the entityTypeId field. SPAs have field description methods regardless of the type settings.
The method name is written in lowercase: crm.smartinvoice.field.list, not crm.smartInvoice.field.list. If the name is written in a different case, the method returns the "Method Not Found" error.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
select |
List of description fields to return, for example, By default, the method returns all description fields |
The method returns the full list of fields: it skips the filter, order, and pagination parameters without an error.
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/crm.smartprocess1038.field.list
The examples retrieve the names, titles, types, and attributes of the fields of an SPA with the type ID 1038. For a different object type, replace the method name according to the table above.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["name","type","title","multiple","editable"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.field.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["name","type","title","multiple","editable"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.field.list
CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(ApiVersion.v3).call.
import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type FieldListResult = {
items: Array<{
name: string
type: string
title: string
multiple: boolean
editable: boolean
}>
}
try {
const response = await $b24.getHttpClient(ApiVersion.v3).call<FieldListResult>(
'crm.smartprocess1038.field.list',
{
select: ['name', 'type', 'title', 'multiple', 'editable'],
},
Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
result.items.forEach((field) => console.info(field.name, field.type, field.editable))
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(B24Js.ApiVersion.v3).call.
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function listFields() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
'crm.smartprocess1038.field.list',
{
select: ['name', 'type', 'title', 'multiple', 'editable'],
},
B24Js.Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
result.items.forEach((field) => console.info(field.name, field.type, field.editable))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listFields)
</script>
b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with prefer_version=3.
from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError
method = "crm.smartprocess1038.field.list"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
try:
response = bitrix_token.call_method(
api_method=method,
params={
"select": ["name", "type", "title", "multiple", "editable"],
},
prefer_version=3,
)
result = response["result"]
for field in result["items"]:
print(field["name"], field["type"], field["editable"])
except BitrixAPIError as error:
print(
"Bitrix API error",
f"code: {error.code}",
f"message: {error.error.message}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
The SDK does not yet support calls to the /rest/api/ address. Use a direct HTTP request, for example, via cURL or fetch.
try {
$response = $b24Service
->core
->call(
'crm.smartprocess1038.field.list',
[
'select' => ['name', 'type', 'title', 'multiple', 'editable'],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
The SDK does not yet support calls to the /rest/api/ address. Use a direct HTTP request, for example, via cURL or fetch.
BX24.callMethod(
'crm.smartprocess1038.field.list',
{
select: ['name', 'type', 'title', 'multiple', 'editable'],
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
The SDK does not yet support calls to the /rest/api/ address. Use a direct HTTP request, for example, via cURL or fetch.
require_once('crest.php');
$result = CRest::call(
'crm.smartprocess1038.field.list',
[
'select' => ['name', 'type', 'title', 'multiple', 'editable'],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.smartprocess1038.field.list", b24.Params{
"select": []string{"name", "type", "title", "multiple", "editable"},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.smartprocess1038.field.list: %w", err)
}
var out struct {
Items []struct {
Name string `json:"name"`
Type string `json:"type"`
Editable bool `json:"editable"`
} `json:"items"`
}
if err := json.Unmarshal(res.Result, &out); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, f := range out.Items {
fmt.Println(f.Name, f.Type, f.Editable)
}
Response Handling
HTTP status: 200
{
"result": {
"items": [
{
"name": "title",
"type": "string",
"multiple": false,
"title": "Name",
"editable": true
},
{
"name": "xmlId",
"type": "string",
"multiple": false,
"title": "External ID",
"editable": true
},
{
"name": "id",
"type": "int",
"multiple": false,
"title": "id",
"editable": false
}
]
},
"time": {
"start": 1793714999,
"finish": 1793714999.191011,
"duration": 0.1910109519958496,
"processing": 0,
"date_start": "2026-11-03T17:09:59+03:00",
"date_finish": "2026-11-03T17:09:59+03:00",
"operating_reset_at": 1793715540,
"operating": 0
}
}
The example shows the first three of 61 fields.
Returned Data
|
Name |
Description |
|
result |
Object with response data |
|
result.items |
Array of field descriptions. Description fields |
|
time |
Information about the request execution time |
Description Fields
|
Name |
Description |
|
name |
Field name: in camelCase for a standard field, for example, |
|
type |
Data type, for example, |
|
elementType |
Element type for composite fields, for example, |
|
multiple |
Whether the field accepts multiple values |
|
title |
Field title in the Bitrix24 language |
|
description |
Field description. If there is no description, |
|
validationRules |
Value validation rules, for example, |
|
requiredGroups |
Methods that require this field, for example, |
|
filterable |
Whether the field can be used for filtering in the crm.<type>.list method |
|
sortable |
Whether the field can be used for sorting in the crm.<type>.list method |
|
editable |
Whether the field can be passed in the crm.<type>.add and crm.<type>.update methods |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION",
"message": "Unknown field \"foo\" found in entity \"CrmFieldMetadataDto\"."
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Check the names in |
Select Format Error
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Invalid field in |
Pass |
Access Denied
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION, HTTP status: 403
|
Field |
Error description |
How to Fix |
|
|
Access denied |
Call the method on behalf of a user with permission to read items of this object type |
Method Not Found
Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404
|
Field |
Error description |
How to Fix |
|
|
Method |
Check the method name: it is written in lowercase, for example, |
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 |