Get the list of call lists crm.calllist.list

Scope: crm

Who can execute the method: user with read access permission for CRM elements

The method crm.calllist.list returns a list of call list activities.

Method Parameters

Required parameters are marked with *

Name
type

Description

SELECT
array

Array of fields to retrieve. By default, all fields are returned.
List of fields to retrieve:

  • ID,
  • DATE_CREATE,
  • CREATED_BY_ID,
  • WEBFORM_ID,
  • ENTITY_TYPE_ID

FILTER
object

Object format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }
  • field_n — name of the field by which the call list will be filtered
  • value_n — filter value

List of fields for filtering:

  • ID,
  • CREATED_BY_ID,
  • WEBFORM_ID,
  • ENTITY_TYPE_ID.

An additional prefix can be assigned to the field to specify the filter behavior. Possible prefix values:

  • >= — greater than or equal to,
  • > — greater than,
  • <= — less than or equal to,
  • < — less than,
  • @ — IN, an array is passed as the value,
  • !@— NOT IN, an array is passed as the value,
  • = — equal, exact match, used by default,
  • != - not equal,
  • ! — not equal

ORDER
object

Object format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }
  • field_n — name of the field by which the call list will be sorted
  • value_n — value of type string, equal to:
    • ASC — ascending sort
    • DESC — descending sort

Code Examples

How to Use Examples in Documentation

curl -X POST -H "Content-Type: application/json" -H "Accept: application/json" -d '{"SELECT":["ID","CREATED_BY_ID"],"FILTER":{"ENTITY_TYPE_ID":3},"ORDER":{"ID":"DESC"}}' https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.calllist.list
        
curl -X POST -H "Content-Type: application/json" -H "Accept: application/json" -d '{"SELECT":["ID","CREATED_BY_ID"],"FILTER":{"ENTITY_TYPE_ID":3},"ORDER":{"ID":"DESC"},"auth":"**put_access_token_here**"}' https://**put_your_bitrix24_address**/rest/crm.calllist.list
        
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        try {
          const response = await $b24.callListMethod(
            'crm.calllist.list',
            {
              SELECT: ["ID", "CREATED_BY_ID"],
              FILTER: { "ENTITY_TYPE_ID": 3 },
              ORDER: { "ID": "DESC" }
            },
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('crm.calllist.list', { SELECT: ["ID", "CREATED_BY_ID"], FILTER: { "ENTITY_TYPE_ID": 3 }, ORDER: { "ID": "DESC" } }, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('crm.calllist.list', { SELECT: ["ID", "CREATED_BY_ID"], FILTER: { "ENTITY_TYPE_ID": 3 }, ORDER: { "ID": "DESC" } }, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.calllist.list',
                    [
                        'SELECT' => ['ID', 'CREATED_BY_ID'],
                        'FILTER' => ['ENTITY_TYPE_ID' => 3],
                        'ORDER'  => ['ID' => 'DESC'],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching call list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.calllist.list",
            {
                SELECT: ["ID", "CREATED_BY_ID"],
                FILTER: { "ENTITY_TYPE_ID": 3 },
                ORDER: { "ID": "DESC" }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.dir(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.calllist.list',
            [
                'SELECT' => ['ID', 'CREATED_BY_ID'],
                'FILTER' => ['ENTITY_TYPE_ID' => 3],
                'ORDER' => ['ID' => 'DESC']
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": [
                {
                    "ID": "13",
                    "CREATED_BY_ID": "29"
                },
                {
                    "ID": "9",
                    "CREATED_BY_ID": "1"
                },
                {
                    "ID": "3",
                    "CREATED_BY_ID": "131"
                },
                {
                    "ID": "1",
                    "CREATED_BY_ID": "131"
                }
            ],
            "time": {
                "start": 1752475786.965766,
                "finish": 1752475787.035008,
                "duration": 0.06924200057983398,
                "processing": 0.016666889190673828,
                "date_start": "2025-07-14T09:49:46+02:00",
                "date_finish": "2025-07-14T09:49:47+02:00",
                "operating_reset_at": 1752476387,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
array

Root element of the response. Contains an array of objects with information about call lists.

The structure of fields depends on the select parameter

time
time

Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error": "Invalid parameters.",
            "error_description": "Invalid parameters were provided."
        }

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code

Description

Value

400

Invalid parameters

Invalid parameters were provided

100

Unknown field definition "TITLE"

Unknown parameter "Field name"

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 allowed to be called 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 methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users

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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Previous
Get Participants of the Call List
Next
Get a List of Call List Statuses