Get the list of contacts crm.contact.list

Scope: crm

Who can execute the method: any user with "read" access permission for contacts

Method Development Stopped

The method crm.contact.list continues to function, but there is a more relevant alternative crm.item.list.

The method crm.contact.list returns a list of contacts based on a filter. It is an implementation of the list method for contacts.

To get a list of companies associated with a contact, use the method crm.contact.company.items.get

Method Parameters

Name
type

Description

select
string[]

List of fields that should be filled in the contacts in the selection.

You can use masks in the selection:

  • '*' — to select all fields (excluding custom and multiple fields)
  • 'UF_*' — to select all custom fields (excluding multiple fields)

There are no masks for selecting multiple fields. To select multiple fields, specify the required ones in the selection list (PHONE, EMAIL, etc.).

You can find the list of available fields for selection using the method crm.contact.fields.

By default, all fields are taken — '*' + Custom fields — 'UF_*'

filter
object

Object format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

where:

  • field_n — the name of the field by which the selection of elements will be filtered
  • value_n — the filter value

You can add a prefix to the keys field_n to clarify the filter operation.
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
  • % — LIKE, substring search. The % symbol in the filter value does not need to be passed. The search looks for a substring in any position of the string
  • =% — LIKE, substring search. The % symbol needs to be passed in the value. Examples:
    • "mol%" — searches for values starting with "mol"
    • "%mol" — searches for values ending with "mol"
    • "%mol%" — searches for values where "mol" can be in any position
  • %= — LIKE (similar to =%)
  • = — equals, exact match (used by default)
  • != — not equal
  • ! — not equal

The fields Phone (PHONE), Email (EMAIL), Website (WEB), Messengers (IM), Links (LINK) — are multiple. Filters for them only work on exact matches.

Also, the LIKE filter does not work with fields of type crm_status, crm_contact, crm_company — for example, Contact Type (TYPE_ID), Salutation (HONORIFIC), etc.

You can find the list of available fields for filtering using the method crm.contact.fields.

The logic key in the filter is not supported. To use complex logic in the filter, use the method crm.item.list

order
object

Object format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

where:

  • field_n — the name of the field by which the selection of contacts will be sorted
  • value_n — a string value equal to:
    • ASC — ascending sort
    • DESC — descending sort

You can find the list of available fields for sorting using the method crm.contact.fields

start
integer

Parameter for managing pagination.

The page size of results is always static — 50 records.

To select the second page of results, pass the value 50. To select the third page of results — the value 100, and so on.

The formula for calculating the value of the start parameter:

start = (N-1) * 50, where N — the number of the desired page

Also, see the description of list methods.

Code Examples

How to Use Examples in Documentation

Get a list of contacts where:

  1. the source is CRM Form
  2. first name and last name are not empty
  3. first name or last name starts with "I"
  4. are participating in the export
  5. e-mail equals 'special-for@example.com'
  6. the responsible person's ID is either 1 or 6
  7. created less than 6 months ago

Set the order of sorting the selection: first name and last name in ascending order.

For clarity, select only the necessary fields:

  • Contact ID
  • First Name
  • Last Name
  • E-mail
  • Participating in export
  • Responsible
  • Creation Date
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"FILTER":{"SOURCE_ID":"CRM_FORM","!=NAME":"","!=LAST_NAME":"","=%NAME":"I%","=%LAST_NAME":"I%","EMAIL":"special-for@example.com","@ASSIGNED_BY_ID":[1,6],"IMPORT":"Y",">=DATE_CREATE":"**put_six_month_ago_date_here**"},"ORDER":{"LAST_NAME":"ASC","NAME":"ASC"},"SELECT":["ID","NAME","LAST_NAME","EMAIL","EXPORT","ASSIGNED_BY_ID","DATE_CREATE"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"FILTER":{"SOURCE_ID":"CRM_FORM","!=NAME":"","!=LAST_NAME":"","=%NAME":"I%","=%LAST_NAME":"I%","EMAIL":"special-for@example.com","@ASSIGNED_BY_ID":[1,6],"IMPORT":"Y",">=DATE_CREATE":"**put_six_month_ago_date_here**"},"ORDER":{"LAST_NAME":"ASC","NAME":"ASC"},"SELECT":["ID","NAME","LAST_NAME","EMAIL","EXPORT","ASSIGNED_BY_ID","DATE_CREATE"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.contact.list
        
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        const sixMonthAgo = new Date();
        sixMonthAgo.setMonth(new Date().getMonth() - 6);
        
        try {
          const response = await $b24.callListMethod(
            'crm.contact.list',
            {
              filter: {
                "SOURCE_ID": "CRM_FORM",
                "!=NAME": "",
                "!=LAST_NAME": "",
                "=%NAME": "I%",
                "=%LAST_NAME": "I%",
                "EMAIL": "special-for@example.com",
                "@ASSIGNED_BY_ID": [1, 6],
                "IMPORT": "Y",
                ">=DATE_CREATE": sixMonthAgo.toISOString(),
              },
              order: {
                LAST_NAME: "ASC",
                NAME: "ASC",
              },
              select: [
                "ID",
                "NAME",
                "LAST_NAME",
                "EMAIL",
                "EXPORT",
                "ASSIGNED_BY_ID",
                "DATE_CREATE",
              ],
            },
            (result) => {
              result.error()
                ? console.error(result.error())
                : console.info(result.data())
              ;
            }
          );
        } 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.
        
        const sixMonthAgo = new Date();
        sixMonthAgo.setMonth(new Date().getMonth() - 6);
        
        try {
          const generator = $b24.fetchListMethod('crm.contact.list', {
            filter: {
              "SOURCE_ID": "CRM_FORM",
              "!=NAME": "",
              "!=LAST_NAME": "",
              "=%NAME": "I%",
              "=%LAST_NAME": "I%",
              "EMAIL": "special-for@example.com",
              "@ASSIGNED_BY_ID": [1, 6],
              "IMPORT": "Y",
              ">=DATE_CREATE": sixMonthAgo.toISOString(),
            },
            order: {
              LAST_NAME: "ASC",
              NAME: "ASC",
            },
            select: [
              "ID",
              "NAME",
              "LAST_NAME",
              "EMAIL",
              "EXPORT",
              "ASSIGNED_BY_ID",
              "DATE_CREATE",
            ],
          }, '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.
        
        const sixMonthAgo = new Date();
        sixMonthAgo.setMonth(new Date().getMonth() - 6);
        
        try {
          const response = await $b24.callMethod('crm.contact.list', {
            filter: {
              "SOURCE_ID": "CRM_FORM",
              "!=NAME": "",
              "!=LAST_NAME": "",
              "=%NAME": "I%",
              "=%LAST_NAME": "I%",
              "EMAIL": "special-for@example.com",
              "@ASSIGNED_BY_ID": [1, 6],
              "IMPORT": "Y",
              ">=DATE_CREATE": sixMonthAgo.toISOString(),
            },
            order: {
              LAST_NAME: "ASC",
              NAME: "ASC",
            },
            select: [
              "ID",
              "NAME",
              "LAST_NAME",
              "EMAIL",
              "EXPORT",
              "ASSIGNED_BY_ID",
              "DATE_CREATE",
            ],
          }, 0);
          const result = response.getData().result || [];
          for (const entity of result) {
            console.log('Entity:', entity);
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
try {
            $sixMonthAgo = new DateTime();
            $sixMonthAgo->setDate((new DateTime())->getMonth() - 6);
        
            $response = $b24Service
                ->core
                ->call(
                    'crm.contact.list',
                    [
                        'filter' => [
                            'SOURCE_ID'      => 'CRM_FORM',
                            '!=NAME'         => '',
                            '!=LAST_NAME'    => '',
                            '=%NAME'         => 'I%',
                            '=%LAST_NAME'    => 'I%',
                            'EMAIL'          => 'special-for@example.com',
                            '@ASSIGNED_BY_ID' => [1, 6],
                            'IMPORT'         => 'Y',
                            '>=DATE_CREATE'  => $sixMonthAgo->format('Y-m-d\TH:i:s'),
                        ],
                        'order'  => [
                            'LAST_NAME' => 'ASC',
                            'NAME'      => 'ASC',
                        ],
                        'select' => [
                            'ID',
                            'NAME',
                            'LAST_NAME',
                            'EMAIL',
                            'EXPORT',
                            'ASSIGNED_BY_ID',
                            'DATE_CREATE',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching contact list: ' . $e->getMessage();
        }
        
const sixMonthAgo = new Date();
        sixMonthAgo.setMonth((new Date()).getMonth() - 6);
        
        BX24.callMethod(
            'crm.contact.list',
            {
                filter: {
                    "SOURCE_ID": "CRM_FORM",
                    "!=NAME": "",
                    "!=LAST_NAME": "",
                    "=%NAME": "I%",
                    "=%LAST_NAME": "I%",
                    "EMAIL": "special-for@example.com",
                    "@ASSIGNED_BY_ID": [1, 6],
                    "IMPORT": "Y",
                    ">=DATE_CREATE": sixMonthAgo.toISOString(),
                },
                order: {
                    LAST_NAME: "ASC",
                    NAME: "ASC",
                },
                select: [
                    "ID",
                    "NAME",
                    "LAST_NAME",
                    "EMAIL",
                    "EXPORT",
                    "ASSIGNED_BY_ID",
                    "DATE_CREATE",
                ],
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $sixMonthAgo = new DateTime();
        $sixMonthAgo->modify('-6 months');
        
        $result = CRest::call(
            'crm.contact.list',
            [
                'FILTER' => [
                    'SOURCE_ID' => 'CRM_FORM',
                    '!=NAME' => '',
                    '!=LAST_NAME' => '',
                    '=%NAME' => 'I%',
                    '=%LAST_NAME' => 'I%',
                    'EMAIL' => 'special-for@example.com',
                    '@ASSIGNED_BY_ID' => [1, 6],
                    'IMPORT' => 'Y',
                    '>=DATE_CREATE' => $sixMonthAgo->format(DateTime::ATOM),
                ],
                'ORDER' => [
                    'LAST_NAME' => 'ASC',
                    'NAME' => 'ASC',
                ],
                'SELECT' => [
                    'ID',
                    'NAME',
                    'LAST_NAME',
                    'EMAIL',
                    'EXPORT',
                    'ASSIGNED_BY_ID',
                    'DATE_CREATE',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
        	"result": [
        		{
        			"ID": "75",
        			"NAME": "Emily",
        			"LAST_NAME": "Smith",
        			"EXPORT": "Y",
        			"ASSIGNED_BY_ID": "6",
        			"DATE_CREATE": "2024-02-26T00:00:00+02:00",
        			"EMAIL": [
        				{
        					"ID": "215",
        					"VALUE_TYPE": "WORK",
        					"VALUE": "special-for@example.com",
        					"TYPE_ID": "EMAIL"
        				}
        			]
        		},
        		{
        			"ID": "74",
        			"NAME": "James",
        			"LAST_NAME": "Johnson",
        			"EXPORT": "Y",
        			"ASSIGNED_BY_ID": "1",
        			"DATE_CREATE": "2024-08-15T00:00:00+02:00",
        			"EMAIL": [
        				{
        					"ID": "214",
        					"VALUE_TYPE": "WORK",
        					"VALUE": "special-for@example.com",
        					"TYPE_ID": "EMAIL"
        				}
        			]
        		},
        		{
        			"ID": "78",
        			"NAME": "James",
        			"LAST_NAME": "Johnson",
        			"EXPORT": "Y",
        			"ASSIGNED_BY_ID": "1",
        			"DATE_CREATE": "2024-08-15T00:00:00+02:00",
        			"EMAIL": [
        				{
        					"ID": "218",
        					"VALUE_TYPE": "WORK",
        					"VALUE": "special-for@example.com",
        					"TYPE_ID": "EMAIL"
        				}
        			]
        		},
        		{
        			"ID": "77",
        			"NAME": "Jessica",
        			"LAST_NAME": "Williams",
        			"EXPORT": "Y",
        			"ASSIGNED_BY_ID": "6",
        			"DATE_CREATE": "2024-07-01T00:00:00+02:00",
        			"EMAIL": [
        				{
        					"ID": "217",
        					"VALUE_TYPE": "WORK",
        					"VALUE": "special-for@example.com",
        					"TYPE_ID": "EMAIL"
        				}
        			]
        		},
        		{
        			"ID": "73",
        			"NAME": "John",
        			"LAST_NAME": "Brown",
        			"EXPORT": "Y",
        			"ASSIGNED_BY_ID": "1",
        			"DATE_CREATE": "2024-02-20T00:00:00+02:00",
        			"EMAIL": [
        				{
        					"ID": "213",
        					"VALUE_TYPE": "WORK",
        					"VALUE": "special-for@example.com",
        					"TYPE_ID": "EMAIL"
        				}
        			]
        		}
        	],
        	"total": 5,
        	"time": {
        		"start": 1723807142.916445,
        		"finish": 1723807143.44846,
        		"duration": 0.5320150852203369,
        		"processing": 0.1967020034790039,
        		"date_start": "2024-08-16T13:19:02+02:00",
        		"date_finish": "2024-08-16T13:19:03+02:00"
        	}
        }

Returned Data

Name
type

Description

result
contact[]

The root element of the response. An array containing information about the found contacts.

The fields of an individual contact are configured by the select parameter

total
integer

The total number of contacts found based on the specified conditions

next
integer

Contains the value to be passed in the next request in the start parameter to get the next batch of data.

The next parameter appears in the response if the number of elements matching your request exceeds 50

time
time

Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "Access denied."
        }

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

-

Access denied

The user does not have permission for "Read" contacts

-

Parameter 'order' must be array

A non-array was passed to the order parameter

-

Parameter 'filter' must be array

A non-array was passed to the filter parameter

-

Failed to get list. General error

An unknown error occurred

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 contact by Id
Next
Delete contact