Get a List of Custom Fields v 3.0 crm.[type].field.custom.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: crm

Who can execute the method: a user with the "Edit CRM preferences" permission in CRM

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.custom.list method returns the custom fields of an object type with their settings. The object type is set by the <type> segment of the method name.

Method Name for the Object Type

Object type

Method

Fields

Deal

crm.deal.field.custom.list

Deal fields

Lead

crm.lead.field.custom.list

Lead fields

Contact

crm.contact.field.custom.list

Contact fields

Company

crm.company.field.custom.list

Company fields

Estimate

crm.quote.field.custom.list

Estimate fields

Invoice

crm.smartinvoice.field.custom.list

Invoice fields

SPA

crm.smartprocess<entityTypeId>.field.custom.list, for example, crm.smartprocess1038.field.custom.list

SPA fields

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 custom field methods regardless of the type settings. My company does not have these methods: Bitrix24 responds to crm.mycompany.field.custom.list with the "Method Not Found" error.

The method name is written in lowercase: crm.smartinvoice.field.custom.list, not crm.smartInvoice.field.custom.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
type

Description

select
array

List of field parameters to return, for example, ["id", "name", "userTypeId"]. You can pass id, entityId, and the parameters from the description of the fields parameter of the create method.

By default, the method returns all field parameters

filter
array

Field selection conditions. Parameter description

order
object

Sorting in the format {"parameter": "asc"} or {"parameter": "desc"}. You can sort by id and name

pagination
object

Pagination: limit — the number of fields to return, offset — the number of fields to skip, for example, {"limit": 20, "offset": 40}

The filter Parameter

An array of conditions in the form ["parameter", "operator", "value"], for example, [["name", "=", "UF_CRM_CONTRACT_NUMBER"]]. The condition format is described in the REST 3.0 overview.

You can filter by these parameters:

  • id — field ID
  • name — field name
  • entityId — object type code

The method does not filter by other parameters, for example, userTypeId, and returns a request validation error. If filter is passed as a string instead of an array, the method returns a filter 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.custom.list

The examples retrieve the names, types, and labels of the custom fields of an SPA with the type ID 1038, sorted by name. 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":["id","name","userTypeId","editFormLabel"],"order":{"name":"asc"}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.field.custom.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","name","userTypeId","editFormLabel"],"order":{"name":"asc"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.field.custom.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 CustomFieldListResult = {
          items: Array<{
            id: number
            name: string
            userTypeId: string
            editFormLabel: string | null
          }>
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<CustomFieldListResult>(
            'crm.smartprocess1038.field.custom.list',
            {
              select: ['id', 'name', 'userTypeId', 'editFormLabel'],
              order: {
                name: 'asc',
              },
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            result.items.forEach((field) => console.info(field.id, field.name, field.userTypeId))
          }
        } 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 listCustomFields() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.smartprocess1038.field.custom.list',
                {
                  select: ['id', 'name', 'userTypeId', 'editFormLabel'],
                  order: {
                    name: 'asc',
                  },
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              result.items.forEach((field) => console.info(field.id, field.name, field.userTypeId))
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listCustomFields)
        </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.custom.list"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "select": ["id", "name", "userTypeId", "editFormLabel"],
                    "order": {
                        "name": "asc",
                    },
                },
                prefer_version=3,
            )
            result = response["result"]
            for field in result["items"]:
                print(field["id"], field["name"], field["userTypeId"])
        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.custom.list',
                    [
                        'select' => ['id', 'name', 'userTypeId', 'editFormLabel'],
                        'order' => [
                            'name' => 'asc',
                        ],
                    ]
                );
        
            $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.custom.list',
            {
                select: ['id', 'name', 'userTypeId', 'editFormLabel'],
                order: {
                    name: 'asc',
                },
            },
            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.custom.list',
            [
                'select' => ['id', 'name', 'userTypeId', 'editFormLabel'],
                'order' => [
                    'name' => 'asc',
                ],
            ]
        );
        
        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.custom.list", b24.Params{
        	"select": []string{"id", "name", "userTypeId", "editFormLabel"},
        	"order": b24.Params{
        		"name": "asc",
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.smartprocess1038.field.custom.list: %w", err)
        }
        
        var out struct {
        	Items []struct {
        		ID   int    `json:"id"`
        		Name string `json:"name"`
        	} `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.ID, f.Name)
        }
        

Response Handling

HTTP status: 200

{
            "result": {
                "items": [
                    {
                        "id": 6008205,
                        "name": "UF_CRM_19_PRIORITY",
                        "userTypeId": "enumeration",
                        "editFormLabel": "Priority"
                    },
                    {
                        "id": 6008209,
                        "name": "UF_CRM_CONTRACT_NUMBER",
                        "userTypeId": "string",
                        "editFormLabel": "Client contract number"
                    }
                ]
            },
            "time": {
                "start": 1793716018,
                "finish": 1793716018.213075,
                "duration": 0.2130749225616455,
                "processing": 0,
                "date_start": "2026-11-03T17:26:58+03:00",
                "date_finish": "2026-11-03T17:26:58+03:00",
                "operating_reset_at": 1793716560,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with response data

result.items
array

Array of field descriptions with the parameters from select. Without select, all field parameters, id, and entityId. The array is empty if there are no fields or the user does not have the "Edit CRM preferences" permission in CRM

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "DTO \"CustomFieldConfigDto\" in field \"userTypeId\" requires attribute \"Filterable\" to perform this request.",
                        "field": "userTypeId"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

userTypeId

DTO CustomFieldConfigDto in field userTypeId requires attribute Filterable to perform this request

Filter only by id, name, and entityId

sort

DTO CustomFieldConfigDto in field sort requires attribute Sortable to perform this request

Sort only by id and name

Filter Error

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Field

Error description

How to Fix

-

Invalid filter Unknown filter condition

Pass filter as an array of conditions, for example, [["name", "=", "UF_CRM_CONTRACT_NUMBER"]]

Unknown Filter Operator

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNFILTEROPERATOREXCEPTION

Field

Error description

How to Fix

-

Unknown filter operator %

Use the operators from the REST 3.0 overview

Sort Error

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDORDEREXCEPTION

Field

Error description

How to Fix

-

Invalid sort order #VALUE#

Pass the asc or desc direction

Pagination Error

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION

Field

Error description

How to Fix

-

Incorrect pagination parameter value: #VALUE#

Pass a limit greater than zero and an offset of zero or greater

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

-

Unknown field #FIELD# found in entity CustomFieldConfigDto

Check the names in select: the allowed names are the field parameters, id, and entityId

Select Format Error

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION

Field

Error description

How to Fix

-

Invalid field in select: #VALUE#

Pass select as an array of names, for example, ["id", "name"]

Method Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404

Field

Error description

How to Fix

-

Method #METHOD# was not found

Check the method name: it is written in lowercase, for example, crm.smartinvoice.field.custom.list. For an SPA, check entityTypeId with the crm.type.list method. My company does not have these methods

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Continue Learning