Get Custom Field List Values forum.message.field.custom.enum.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: forum

Who can execute the method: any user

The 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 forum.message.field.custom.enum.list method returns all values of a forum message custom field of the List type.

Method Parameters

Required parameters are marked with *

Name
type

Description

filter*
array

Identifier of the custom field whose values you need to retrieve. Pass a single condition in the ["fieldId", identifier] format, for example ["fieldId", 6008093].

The method accepts the filter only in this form. The standard REST 3.0 format — an array of conditions [["fieldId", 6008093]] or [["fieldId", "=", 6008093]] — causes an error.

The field must be of the enumeration type. The identifier can be retrieved using the forum.message.field.custom.list method

select
array

Array of value fields to return in the response.

Available fields:

  • id — value identifier
  • fieldId — custom field identifier
  • value — value text
  • isDefault — default value flag
  • sort — sort order
  • xmlId — external code of the value

Default: all fields

The method returns all values of the field in a single request, sorted by sort in ascending order. The order and pagination parameters do not affect the result. Sorting by any field other than id causes a validation 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}/forum.message.field.custom.enum.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":["fieldId",6008093],"select":["id","value","isDefault","sort","xmlId"]}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/forum.message.field.custom.enum.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":["fieldId",6008093],"select":["id","value","isDefault","sort","xmlId"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/forum.message.field.custom.enum.list
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type EnumValueListResult = {
          items: {
            id: number
            value: string
            isDefault: boolean
            sort: number
            xmlId: string
          }[]
        }
        
        try {
          const response = await $b24.actions.v3.call.make<EnumValueListResult>({
            method: 'forum.message.field.custom.enum.list',
            params: {
              filter: ['fieldId', 6008093],
              select: ['id', 'value', 'isDefault', 'sort', 'xmlId'],
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            result.items.forEach(item => console.info(item.id, item.value))
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function listEnumValues() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'forum.message.field.custom.enum.list',
                params: {
                  filter: ['fieldId', 6008093],
                  select: ['id', 'value', 'isDefault', 'sort', 'xmlId'],
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              result.items.forEach(item => console.info(item.id, item.value))
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listEnumValues)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.forum.message.field.custom.enum.list(
                filter=["fieldId", 6008093],
                select=["id", "value", "isDefault", "sort", "xmlId"],
            ).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}")
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'forum.message.field.custom.enum.list',
                    [
                        'filter' => ['fieldId', 6008093],
                        'select' => ['id', 'value', 'isDefault', 'sort', 'xmlId'],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

BX24.callMethod(
            'forum.message.field.custom.enum.list',
            {
                filter: ['fieldId', 6008093],
                select: ['id', 'value', 'isDefault', 'sort', 'xmlId'],
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'forum.message.field.custom.enum.list',
            [
                'filter' => ['fieldId', 6008093],
                'select' => ['id', 'value', 'isDefault', 'sort', 'xmlId'],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "forum.message.field.custom.enum.list", b24.Params{
        	"filter": []any{"fieldId", 6008093},
        	"select": []string{"id", "value", "isDefault", "sort", "xmlId"},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("forum.message.field.custom.enum.list: %w", err)
        }
        
        // The method wraps the response in an object with the "items" key.
        raw, ok := b24.Unwrap(res.Result, "items")
        if !ok {
        	return fmt.Errorf("no items key in the response")
        }
        
        var items []struct {
        	ID        int    `json:"id"`
        	Value     string `json:"value"`
        	IsDefault bool   `json:"isDefault"`
        	Sort      int    `json:"sort"`
        	XMLID     string `json:"xmlId"`
        }
        if err := json.Unmarshal(raw, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, item := range items {
        	fmt.Println(item.ID, item.Value)
        }
        

Response Handling

HTTP status: 200

{
            "result": {
                "items": [
                    {
                        "id": 4077,
                        "value": "Urgent",
                        "isDefault": false,
                        "sort": 5,
                        "xmlId": "HIGH"
                    },
                    {
                        "id": 4079,
                        "value": "Normal",
                        "isDefault": true,
                        "sort": 20,
                        "xmlId": "NORMAL"
                    },
                    {
                        "id": 4081,
                        "value": "Low",
                        "isDefault": true,
                        "sort": 30,
                        "xmlId": "LOW"
                    }
                ]
            },
            "time": {
                "start": 1792670773,
                "finish": 1792670773.884,
                "duration": 0.8840000629425049,
                "processing": 0,
                "date_start": "2026-10-22T15:06:13+02:00",
                "date_finish": "2026-10-22T15:06:13+02:00",
                "operating_reset_at": 1792671360,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with the response data

result.items
array

Array of field values. The set of fields depends on select. If the field has no values, the array is empty. Field description

time
time

Information about the request execution time

Items Element

Name
type

Description

id
integer

List value identifier

fieldId
integer

Identifier of the custom field the value belongs to

value
string

Value text

isDefault
boolean

true — default value, false — regular value. Several values of the field can have the flag

sort
integer

Sort order

xmlId
string

External code of the value

Error Handling

HTTP status: 400, 404

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION",
                "message": "Error validating request object filters.",
                "validation": [
                    {
                        "message": "Filter for required field \"fieldId\" is required.",
                        "field": "filter.fieldId"
                    }
                ]
            }
        }
        

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

Filter Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION

Field

Error description

How to Fix

filter.fieldId

Filter for required field fieldId is required

Pass the filter as a single condition ["fieldId", 6008093], without the outer array

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Field

Error description

How to Fix

filter

Invalid filter Unknown filter condition

Pass the filter as an array ["fieldId", 6008093], not as an object

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

filter

Field value must not be empty

Pass filter with the field identifier

fieldId

This request requires data type int in field fieldId

Pass the field identifier as a number, not as a string

#FIELD#

DTO EnumDto in field #FIELD# requires attribute Sortable to perform this request

Do not pass order: the method does not apply it

Field Not Found Error

Error Code: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION

HTTP status: 404

Field

Error description

How to Fix

-

Field #FIELD_ID# was not found

Forum messages have no custom field with this identifier, or its type is not enumeration. Check the field using the forum.message.field.custom.list method

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

select

Unknown field #FIELD# found in entity EnumDto

Pass in select only the fields from the items element description

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