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:
callWho 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 |
Description |
|
filter* |
Selection criteria (detailed description) |
|
select |
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: In Fields |
|
order |
Sorting parameters (detailed description). Default: |
|
pagination |
Cursor pagination parameters (detailed description) |
|
mentionFormat |
Format of user mentions in text AI fields. Possible values:
Default: |
Parameter filter
|
Name |
Description |
|
startDate* |
Call start period (detailed description) |
|
participantId |
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 |
Description |
|
from* |
Period start in ISO 8601 format. For example: |
|
to* |
Period end in ISO 8601 format. The value must be greater than or equal to |
Parameter order
|
Name |
Description |
|
startDate |
Sort direction by call start date. Possible values:
Default: |
Parameter pagination
|
Name |
Description |
|
limit |
Page size. Default: |
|
afterCursor |
Next page cursor. Pass the |
Parameter pagination.afterCursor
To retrieve all pages:
- Send the first request without
pagination.afterCursor - If
hasMorein the response equalstrue, copy theafterCursorobject from the response into thepagination.afterCursorof the next request - Repeat requests until
hasMoreequalsfalse
|
Name |
Description |
|
startDate* |
Start date of the last item of the previous page |
|
id* |
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>';
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 |
Description |
|
result |
Object with response data |
|
items |
Array of Follow-up objects. The composition of fields depends on If no matching Follow-ups are found, an empty array |
|
hasMore |
Presence indicator for the next page |
|
afterCursor |
Cursor to retrieve the next page. If there is no next page, |
|
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 |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
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 |
Filter Errors
Error Code: invalid_date_range
|
Field |
Error description |
How to Fix |
|
|
Incorrect date range |
Pass |
Errors in the select Parameter
Error Code: invalid_select_field
|
Field |
Error description |
How to Fix |
|
|
Invalid field in |
Pass a field from the list of available values |
Sorting Errors
Error Code: invalid_order
|
Field |
Error description |
How to Fix |
|
|
Incorrect parameter |
Pass |
Pagination Errors
Error Code: invalid_pagination
|
Field |
Error description |
How to Fix |
|
|
Incorrect parameter |
Pass a positive integer |
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
An invalid participant identifier type was passed |
Pass |
|
|
A value not from the list of allowed formats was passed |
Provide |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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 |