Get Follow-up Field Description call.followup.field.get

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: call

Who can execute the method: any user

The method belongs to REST 3.0. Calling features and the response format of the new API version are described in the REST 3.0 Overview.

The call.followup.field.get method returns the description of the Follow-up field by name.

Method Parameters

Required parameters are marked with *

Name
type

Description

name*
string

The name of the Follow-up field for which the description needs to be obtained.

Available fields can be obtained using the call.followup.field.list method

select
array

List of description fields to return in the response.

Available fields:

  • name — field name
  • type — data type
  • title — title
  • description — description
  • validationRules — validation rules
  • requiredGroups — required groups
  • filterable — filter availability indicator
  • sortable — sort availability indicator
  • editable — editability indicator
  • multiple — multiple value indicator
  • elementType — element type for composite fields

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ parameter to the request:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/call.followup.field.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"name":"callId","select":["name","type","title","description","filterable","sortable","multiple"]}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/call.followup.field.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"name":"callId","select":["name","type","title","description","filterable","sortable","multiple"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/call.followup.field.get
        
// 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 the payload returned in result (match the "response handling" section of the page)
        type FollowUpFieldGetResult = {
          item: {
            name: string
            type: string
            title: string
            description: string | null
            filterable: boolean
            sortable: boolean
            multiple: boolean
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<FollowUpFieldGetResult>({
            method: 'call.followup.field.get',
            params: {
              name: 'callId',
              select: ['name', 'type', 'title', 'description', 'filterable', 'sortable', 'multiple'],
            },
            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(result.item.name, result.item.type, result.item.title)
          }
        } 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 getFollowUpField() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'call.followup.field.get',
                params: {
                  name: 'callId',
                  select: ['name', 'type', 'title', 'description', 'filterable', 'sortable', 'multiple'],
                },
                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(result.item.name, result.item.type, result.item.title)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getFollowUpField)
        </script>
        

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(
                    'call.followup.field.get',
                    [
                        'name' => 'callId',
                        'select' => ['name', 'type', 'title', 'description', 'filterable', 'sortable', 'multiple']
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, 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(
            'call.followup.field.get',
            {
                name: 'callId',
                select: ['name', 'type', 'title', 'description', 'filterable', 'sortable', 'multiple']
            },
            function(result) {
                console.info(result.data());
                console.log(result);
            }
        );
        

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(
            'call.followup.field.get',
            [
                'name' => 'callId',
                'select' => ['name', 'type', 'title', 'description', 'filterable', 'sortable', 'multiple']
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "call.followup.field.get", b24.Params{
        	"name":   "callId",
        	"select": []string{"name", "type", "title", "description", "filterable", "sortable", "multiple"},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("call.followup.field.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 {
        	Name        string `json:"name"`
        	Type        string `json:"type"`
        	Title       string `json:"title"`
        	Description string `json:"description"`
        	Filterable  bool   `json:"filterable"`
        	Sortable    bool   `json:"sortable"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.Name, item.Type)
        

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "name": "callId",
                    "type": "int",
                    "title": "callId",
                    "description": "Bitrix24 call identifier (b_call.ID). Always present.",
                    "filterable": false,
                    "sortable": false,
                    "multiple": false
                }
            },
            "time": {
                "start": 1784017027,
                "finish": 1784017027.356922,
                "duration": 0.356921911239624,
                "processing": 0,
                "date_start": "2026-07-14T11:17:07+03:00",
                "date_finish": "2026-07-14T11:17:07+03:00",
                "operating_reset_at": 1784017627,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with response data

item
object

Object with field description. The response structure depends on select

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error during request object validation",
                "validation": [
                    {
                        "field": "name",
                        "message": "Mandatory field `name` is missing"
                    }
                ]
            }
        }
        

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

Access Errors

Error Code: BITRIX_REST_V3_EXCEPTION_INSUFFICIENTSCOPEEXCEPTION

Field

Error description

How to Fix

-

Insufficient access rights: required scope is missing

Check that the application or webhook has the call scope

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field

Error description

How to Fix

-

Access denied

Check user permissions and call scope

Data Not Found Errors

Error Code: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION

Field

Error description

How to Fix

name

Field #FIELD# not found

Provide an existing field name. A list of fields can be obtained using the call.followup.field.list method

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

name

Mandatory field name is not specified

Pass the name parameter with an existing field name

Errors in the select Parameter

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

select

Unknown field #FIELD# for object DtoFieldDto

Provide only description fields: name, type, title, description, validationRules, requiredGroups, filterable, sortable, editable, multiple, elementType

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION

Field

Error description

How to Fix

select

Unable to recognize select expression #SELECT#

Pass select as an array of strings, e.g., ["name","type"]

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

The REST API is available only on commercial plans. 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