Get a List of Follow-up Calls call.followup.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

The method belongs to REST 3.0. Details regarding call specifics and the response format of the new API version are described in the REST 3.0 Overview.

The call.followup.list method returns a list of follow-up calls for the specified period.

Method Parameters

Required parameters are marked with *

Name
type

Description

filter*
object

Selection criteria (detailed description)

select
array

List of fields and nested paths to be returned in the list items.

If the parameter is not passed or an empty array is passed, the method returns only basic metadata: callId, callType, initiatorId, startDate, endDate, durationSeconds.

In select, you can pass root Follow-up fields, AI blocks, or available nested paths via dot notation. For a full list of fields and available nested paths, see the article Follow-up call fields.

Fields transcription, overview, and insights are considered heavy. If they are present in select, server will limit pagination.limit with value 20

order
object

Sorting parameters (detailed description).

Default: { "startDate": "desc" }

pagination
object

Cursor pagination parameters (detailed description)

mentionFormat
string

Format of user mentions in text AI fields.

Possible values:

  • bb — BBCode format
  • html — HTML format
  • none — plain text without mention markup

Default: bb

Parameter filter

Name
type

Description

startDate*
object

Call start period (detailed description)

participantId
integer

Call participant identifier.

An Administrator can obtain Follow-ups for any user. For a regular user, the filter is forcibly restricted to their identifier

Parameter filter.startDate

Name
type

Description

from*
string

Period start in ISO 8601 format. For example: 2026-01-01T00:00:00Z

to*
string

Period end in ISO 8601 format. The value must be greater than or equal to from

Parameter order

Name
type

Description

startDate
string

Sort direction by call start date.

Possible values:

  • asc — ascending
  • desc — descending

Default: desc

Parameter pagination

Name
type

Description

limit
integer

Page size.

Default: 50. Maximum: 200 for light selection and 20 for selection with heavy AI fields. If a value greater than the maximum is passed, the server will apply the maximum value

afterCursor
object

Next page cursor. Pass the afterCursor value in its entirety from the previous response in the same format it was received (detailed description)

Parameter pagination.afterCursor

To retrieve all pages:

  1. Send the first request without pagination.afterCursor
  2. If hasMore in the response equals true, copy the afterCursor object from the response into the pagination.afterCursor of the next request
  3. Repeat requests until hasMore equals false

Name
type

Description

startDate*
string

Start date of the last item of the previous page

id*
integer

Identifier of the last item of the previous page

Code Examples

How to Use Examples in Documentation

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

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"startDate":{"from":"2026-01-01T00:00:00Z","to":"2026-01-31T23:59:59Z"}},"select":["callId","startDate","participants","overview.topic","overview.actionItems"],"order":{"startDate":"desc"},"pagination":{"limit":20},"mentionFormat":"html"}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/call.followup.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"startDate":{"from":"2026-01-01T00:00:00Z","to":"2026-01-31T23:59:59Z"}},"select":["callId","startDate","participants","overview.topic","overview.actionItems"],"order":{"startDate":"desc"},"pagination":{"limit":20},"mentionFormat":"html","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/call.followup.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
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type FollowUpListResult = {
          items: Array<{
            callId: number
            startDate: string
            participants?: unknown[]
            overview?: { topic?: string, actionItems?: unknown[] }
          }>
          hasMore: boolean
          afterCursor: { startDate: string, id: number } | null
        }
        
        try {
          const response = await $b24.actions.v3.call.make<FollowUpListResult>({
            method: 'call.followup.list',
            params: {
              filter: {
                startDate: {
                  from: '2026-01-01T00:00:00Z',
                  to: '2026-01-31T23:59:59Z',
                },
              },
              select: ['callId', 'startDate', 'participants', 'overview.topic', 'overview.actionItems'],
              order: { startDate: 'desc' },
              pagination: { limit: 20 },
              mentionFormat: 'html',
            },
            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.items, result.afterCursor)
          }
        } 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 getFollowUpList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'call.followup.list',
                params: {
                  filter: {
                    startDate: {
                      from: '2026-01-01T00:00:00Z',
                      to: '2026-01-31T23:59:59Z',
                    },
                  },
                  select: ['callId', 'startDate', 'participants', 'overview.topic', 'overview.actionItems'],
                  order: { startDate: 'desc' },
                  pagination: { limit: 20 },
                  mentionFormat: 'html',
                },
                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('Follow-ups found:', result.items.length, result.items)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getFollowUpList)
        </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.list',
                    [
                        'filter' => [
                            'startDate' => [
                                'from' => '2026-01-01T00:00:00Z',
                                'to' => '2026-01-31T23:59:59Z',
                            ],
                        ],
                        'select' => ['callId', 'startDate', 'participants', 'overview.topic', 'overview.actionItems'],
                        'order' => ['startDate' => 'desc'],
                        'pagination' => ['limit' => 20],
                        'mentionFormat' => 'html',
                    ]
                );
        
            $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.list',
            {
                filter: {
                    startDate: {
                        from: '2026-01-01T00:00:00Z',
                        to: '2026-01-31T23:59:59Z'
                    }
                },
                select: ['callId', 'startDate', 'participants', 'overview.topic', 'overview.actionItems'],
                order: { startDate: 'desc' },
                pagination: { limit: 20 },
                mentionFormat: 'html'
            },
            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.list',
            [
                'filter' => [
                    'startDate' => [
                        'from' => '2026-01-01T00:00:00Z',
                        'to' => '2026-01-31T23:59:59Z',
                    ],
                ],
                'select' => ['callId', 'startDate', 'participants', 'overview.topic', 'overview.actionItems'],
                'order' => ['startDate' => 'desc'],
                'pagination' => ['limit' => 20],
                'mentionFormat' => 'html',
            ]
        );
        
        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.list", b24.Params{
        	"filter": b24.Params{
        		"startDate": b24.Params{
        			"from": "2026-01-01T00:00:00Z",
        			"to":   "2026-01-31T23:59:59Z",
        		},
        	},
        	"select": []string{"callId", "startDate", "participants", "overview.topic", "overview.actionItems"},
        	"order": b24.Params{
        		"startDate": "desc",
        	},
        	"pagination": b24.Params{
        		"limit": 20,
        	},
        	"mentionFormat": "html",
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("call.followup.list: %w", err)
        }
        
        var item struct {
        	HasMore bool `json:"hasMore"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.HasMore)
        

Response Handling

HTTP status: 200

{
            "result": {
                "items": [
                    {
                        "callId": 12345,
                        "startDate": "2026-01-15T10:00:00+00:00",
                        "participants": [
                            { "userId": 7, "name": "Klaus Weber", "avatar": "https://...", "talkedSeconds": 600 },
                            { "userId": 42, "name": "Maria Schmidt", "talkedSeconds": 1200 }
                        ],
                        "overview": {
                            "topic": "Sprint planning",
                            "actionItems": [
                                { "actionItem": "Deploy MVP by Friday", "quote": "..." }
                            ]
                        }
                    }
                ],
                "hasMore": true,
                "afterCursor": { "startDate": "2026-01-12T14:30:00.000000+00:00", "id": 12330 }
            },
            "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 Follow-up objects. The composition of fields depends on select.

If no matching Follow-ups are found, an empty array [] will be returned

hasMore
boolean

Presence indicator for the next page

afterCursor
object

Cursor to retrieve the next page.

If there is no next page, null is returned

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "invalid_date_range",
                "message": "Incorrect date range: both from and to are required"
            }
        }
        

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 permissions: required scope is missing

Check that the application or webhook has the scope call

Filter Errors

Error Code: invalid_date_range

Field

Error description

How to Fix

filter.startDate

Incorrect date range

Pass from and to in ISO 8601 format. The value of from must be less than or equal to to

Errors in the select Parameter

Error Code: invalid_select_field

Field

Error description

How to Fix

select

Invalid field in select

Pass a field from the list of available values select

Sorting Errors

Error Code: invalid_order

Field

Error description

How to Fix

order

Incorrect parameter order

Pass { "startDate": "asc" } or { "startDate": "desc" }

Pagination Errors

Error Code: invalid_pagination

Field

Error description

How to Fix

pagination

Incorrect parameter pagination

Pass a positive integer limit and the cursor from the previous response

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

filter.participantId

An invalid participant identifier type was passed

Pass filter.participantId as an integer

mentionFormat

A value not from the list of allowed formats was passed

Provide bb, html, or none

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