Get Follow-up Fields List call.followup.field.list

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

This method belongs to REST 3.0. Details regarding the invocation features and response format of the new API version are described in the REST 3.0 Overview.

The call.followup.field.list method returns a list of available Follow-up fields.

Method Parameters

Required parameters are marked with *

Name
type

Description

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

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["name","type","description"]}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/call.followup.field.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["name","type","description"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/call.followup.field.list

// 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
        
        type FollowUpFieldItem = {
          name: string
          type: string
          description: string | null
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type FollowUpFieldListResult = {
          items: FollowUpFieldItem[]
        }
        
        try {
          const response = await $b24.actions.v3.call.make<FollowUpFieldListResult>({
            method: 'call.followup.field.list',
            params: {
              select: ['name', 'type', 'description'],
            },
            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('Fields count:', result.items.length, 'Fields:', result.items)
          }
        } 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 getFollowUpFieldList() {
            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.list',
                params: {
                  select: ['name', 'type', 'description'],
                },
                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('Fields count:', result.items.length, 'Fields:', result.items)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getFollowUpFieldList)
        </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.list',
                    [
                        'select' => ['name', 'type', 'description']
                    ]
                );
        
            $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.list',
            {
                select: ['name', 'type', 'description']
            },
            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.list',
            [
                'select' => ['name', 'type', 'description']
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "items": [
                    {
                        "name": "callId",
                        "type": "int",
                        "description": "Bitrix24 call identifier (b_call.ID). Always present."
                    },
                    {
                        "name": "callType",
                        "type": "int",
                        "description": "Call type: 1 = instant ad-hoc, 2 = permanent conference room, 3 = large room."
                    },
                    {
                        "name": "initiatorId",
                        "type": "int",
                        "description": "User id of who initiated the call."
                    },
                    {
                        "name": "startDate",
                        "type": "string",
                        "description": "ISO 8601 UTC timestamp when the call started."
                    },
                    {
                        "name": "endDate",
                        "type": "string",
                        "description": "ISO 8601 UTC timestamp when the call ended. Null while the call is still in progress."
                    },
                    {
                        "name": "durationSeconds",
                        "type": "int",
                        "description": "Total call duration in seconds (endDate - startDate)."
                    },
                    {
                        "name": "uuid",
                        "type": "string",
                        "description": "Opaque UUID of the call session. Opt-in: list this in `select` to receive it."
                    },
                    {
                        "name": "language",
                        "type": "string",
                        "description": "Detected transcription language (BCP-47 / ISO 639-1, for example ru or en). Null when there is no transcription."
                    },
                    {
                        "name": "version",
                        "type": "int",
                        "description": "Maximum schema version across all stored outcome blocks for this call."
                    },
                    {
                        "name": "participants",
                        "type": "array",
                        "description": "Call participants, enriched with display data from user profiles."
                    },
                    {
                        "name": "outcomes",
                        "type": "array",
                        "description": "Names of outcome blocks present for this call: transcription, overview, summary, insights, evaluation."
                    },
                    {
                        "name": "createdAt",
                        "type": "string",
                        "description": "ISO 8601 UTC timestamp of the most recently stored outcome record for this call."
                    },
                    {
                        "name": "tracks",
                        "type": "array",
                        "description": "Call recordings / tracks with download URLs. Opt-in via `select`."
                    },
                    {
                        "name": "transcription",
                        "type": "object",
                        "description": "Time-ordered transcription of the call with per-segment speaker attribution."
                    },
                    {
                        "name": "overview",
                        "type": "object",
                        "description": "AI overview of the meeting: topic, agenda, agreements, action items, takeaways."
                    },
                    {
                        "name": "summary",
                        "type": "object",
                        "description": "Segmented summary of the call by topic chunks."
                    },
                    {
                        "name": "insights",
                        "type": "object",
                        "description": "AI insights: per-speaker analysis (CIS only), meeting strengths/weaknesses, recommendations."
                    },
                    {
                        "name": "evaluation",
                        "type": "object",
                        "description": "Meeting efficiency evaluation: overall score and individual evaluation criteria."
                    }
                ]
            },
            "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
items `array`	Array of objects with field descriptions. 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_UNKNOWNDTOPROPERTYEXCEPTION",
                "message": "Unknown field `unknownField` for object `DtoFieldDto`"
            }
        }

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 scope `call`

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field	Error description	How to Fix
`-`	Access denied	Check user permissions and `call` scope

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`	Pass 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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site 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?

Get Follow-up by Call

Get Follow-up Field Description

Get Follow-up Fields List call.followup.field.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Access ErrorsAccess Errors

Errors in the ParameterErrors in the select Parameter

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Access Errors

Errors in the `select` Parameter

Statuses and System Error Codes

Continue Learning