Get Forum Message Custom Field forum.message.field.custom.get

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.get method returns a custom field for forum messages by its identifier.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Custom field identifier.

The identifier can be retrieved using the forum.message.field.custom.list method

select
array

An array of fields to return in the response.

Available fields:

id — field identifier
entityId — object identifier
name — field code
userTypeId — field type
xmlId — external code
sort — sort order
isMultiple — multiple field flag
isMandatory — required field flag
showFilter — display in the list filter
showInList — display in the list
editInList — editability
isSearchable — inclusion in search
settings — field type settings
editFormLabel — edit form label
listColumnLabel — list column label
listFilterLabel — list filter label
errorMessage — error message
helpMessage — help text

Default: all fields

Labels are returned in the response language. The language can be set with the X-Bitrix-Rest-Response-Language header, for example X-Bitrix-Rest-Response-Language: en.

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.get

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":6008091}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/forum.message.field.custom.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":6008091,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/forum.message.field.custom.get

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type CustomFieldGetResult = {
          item: {
            id: number
            entityId: string
            name: string
            userTypeId: string
            xmlId: string | null
            sort: number
            isMultiple: boolean
            isMandatory: boolean
            showFilter: string
            showInList: boolean
            editInList: boolean
            isSearchable: boolean
            settings: Record<string, unknown>
            editFormLabel: string | null
            listColumnLabel: string | null
            listFilterLabel: string | null
            errorMessage: string | null
            helpMessage: string | null
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<CustomFieldGetResult>({
            method: 'forum.message.field.custom.get',
            params: {
              id: 6008091,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info(result.item.name, result.item.userTypeId)
          }
        } 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 getCustomField() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'forum.message.field.custom.get',
                params: {
                  id: 6008091,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info(result.item.name, result.item.userTypeId)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getCustomField)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.forum.message.field.custom.get(
                id=6008091,
            ).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.get',
                    [
                        'id' => 6008091,
                    ]
                );
        
            $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.get',
            {
                id: 6008091,
            },
            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.get',
            [
                'id' => 6008091,
            ]
        );
        
        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.get", b24.Params{
        	"id": 6008091,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("forum.message.field.custom.get: %w", err)
        }
        
        // The method wraps the response in an object with the "item" key.
        raw, ok := b24.Unwrap(res.Result, "item")
        if !ok {
        	return fmt.Errorf("no item key in the response")
        }
        
        var item struct {
        	ID            int     `json:"id"`
        	Name          string  `json:"name"`
        	UserTypeID    string  `json:"userTypeId"`
        	IsMandatory   bool    `json:"isMandatory"`
        	EditFormLabel *string `json:"editFormLabel"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name, item.UserTypeID)

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 6008091,
                    "entityId": "FORUM_MESSAGE",
                    "name": "UF_EXTERNAL_ID",
                    "userTypeId": "string",
                    "xmlId": "EXTERNAL_ID",
                    "sort": 150,
                    "isMultiple": false,
                    "isMandatory": true,
                    "showFilter": "N",
                    "showInList": true,
                    "editInList": true,
                    "isSearchable": true,
                    "settings": {
                        "size": 20,
                        "rows": 1,
                        "regexp": "",
                        "minLength": 0,
                        "maxLength": 0,
                        "defaultValue": ""
                    },
                    "editFormLabel": "External system code",
                    "listColumnLabel": null,
                    "listFilterLabel": null,
                    "errorMessage": null,
                    "helpMessage": null
                }
            },
            "time": {
                "start": 1792670694,
                "finish": 1792670694.618115,
                "duration": 0.6181149482727051,
                "processing": 0,
                "date_start": "2026-10-22T15:04:54+02:00",
                "date_finish": "2026-10-22T15:04:54+02:00",
                "operating_reset_at": 1792671240,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	An object with the response data
result.item `object`	The custom field. The set of fields depends on `select`. Field description
time `time`	Information about the request execution time

Item Object

Name `type`	Description
id `integer`	Custom field identifier
entityId `string`	Identifier of the object the field belongs to. For forum messages, it is always `FORUM_MESSAGE`
name `string`	Field code
userTypeId `string`	Field type, for example `string`, `integer`, `enumeration`, `disk_file`
xmlId `string`	External code of the field. `null` if not set
sort `integer`	Sort order
isMultiple `boolean`	`true` — multiple field, `false` — single field
isMandatory `boolean`	`true` — required field, `false` — optional field
showFilter `string`	How the field is shown in the list filter: `N` — do not show `I` — exact match `E` — mask search `S` — substring search
showInList `boolean`	`true` — the field is shown in the list
editInList `boolean`	`true` — the field value can be edited
isSearchable `boolean`	`true` — the field values are included in search
settings `object`	Field type settings. Keys are returned in camelCase, flags as `true` and `false`. The set of keys depends on the type: for `string` they are `size`, `rows`, `regexp`, `minLength`, `maxLength`, `defaultValue`, for `enumeration` — `display`, `listHeight`, `captionNoValue`, `showNoValue`
editFormLabel `string`	Edit form label in the response language. `null` if the label is not set
listColumnLabel `string`	List column label in the response language. `null` if not set
listFilterLabel `string`	List filter label in the response language. `null` if not set
errorMessage `string`	Error message in the response language. `null` if not set
helpMessage `string`	Help text in the response language. `null` if not set

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
                "message": "Entity with ID 999999999 was not found."
            }
        }

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
`id`	Required field `id` is missing	Pass the custom field `id`

Field Not Found Error

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field	Error description	How to Fix
`id`	Entity with ID `#ID#` was not found	There is no forum message custom field with this `id`. Check the identifier 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 `CustomDto`	Pass in `select` only the fields from the item object 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

Was the article helpful?

Update Forum Message Custom Field

Get List of Forum Message Custom Fields

Get Forum Message Custom Field forum.message.field.custom.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Item ObjectItem Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Field Not Found ErrorField Not Found Error

Unknown Field ErrorUnknown Field Error

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Code Examples

Response Handling

Returned Data

Item Object

Error Handling

Possible Error Codes

Request Validation Errors

Field Not Found Error

Unknown Field Error

Statuses and System Error Codes

Continue Learning