Get a List of Contacts crm.contact.list

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: crm

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

DEPRECATED

The development of this method has been halted. Please use 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 retrieve a list of companies associated with a contact, use the method crm.contact.company.items.get.

Method Parameters

Name
type

Description

select
string[]

A list of fields that should be populated for 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 is no mask 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

An object in the 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 specify 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 =%)
  • = — equal, 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 these fields only work on exact matches.

Additionally, 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

An object in the 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 order
    • DESC — descending order

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

start
integer

A 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 start parameter value:

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

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. they participate in export
  5. e-mail equals 'special-for@example.com'
  6. the responsible ID is either 1 or 6
  7. created less than 6 months ago

Set the order of 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
  • Participation 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
        
// 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, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of each contact object returned in result[]
        type CrmContactListItem = {
          ID: string
          NAME: string
          LAST_NAME: string
          EXPORT: string
          ASSIGNED_BY_ID: string
          DATE_CREATE: ISODate | null
          EMAIL?: CrmContactEmail[]
        }
        
        type CrmContactEmail = {
          ID: string
          VALUE_TYPE: string
          VALUE: string
          TYPE_ID: string
        }
        
        const sixMonthAgo = new Date()
        sixMonthAgo.setMonth(new Date().getMonth() - 6)
        
        try {
          // crm.contact.list returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<CrmContactListItem[]>({
            method: 'crm.contact.list',
            params: {
              filter: {
                SOURCE_ID: 'CRM_FORM',
                '!=NAME': '',
                '!=LAST_NAME': '',
                '=%NAME': 'J%',
                '=%LAST_NAME': 'J%',
                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',
              ],
              start: 0,
            },
            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('Contacts on this page:', result.length, result)
          }
        } 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 listContacts() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const sixMonthAgo = new Date()
              sixMonthAgo.setMonth(new Date().getMonth() - 6)
        
              // crm.contact.list returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'crm.contact.list',
                params: {
                  filter: {
                    SOURCE_ID: 'CRM_FORM',
                    '!=NAME': '',
                    '!=LAST_NAME': '',
                    '=%NAME': 'J%',
                    '=%LAST_NAME': 'J%',
                    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',
                  ],
                  start: 0,
                },
                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('Contacts on this page:', result.length, result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listContacts)
        </script>
        
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>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.contact.list", b24.Params{
        	"filter": b24.Params{
        		"SOURCE_ID":       "CRM_FORM",
        		"!=NAME":          "",
        		"!=LAST_NAME":     "",
        		"=%NAME":          "K%",
        		"=%LAST_NAME":     "W%",
        		"EMAIL":           "special-for@example.com",
        		"@ASSIGNED_BY_ID": []int{1, 6},
        		"IMPORT":          "Y",
        		">=DATE_CREATE":   "**put_six_month_ago_date_here**",
        	},
        	"order": b24.Params{
        		"LAST_NAME": "ASC",
        		"NAME":      "ASC",
        	},
        	"select": []string{"ID", "NAME", "LAST_NAME", "EMAIL", "EXPORT", "ASSIGNED_BY_ID", "DATE_CREATE"},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.contact.list: %w", err)
        }
        
        var items []struct {
        	ID           b24.ID `json:"ID"`
        	Name         string `json:"NAME"`
        	LastName     string `json:"LAST_NAME"`
        	Export       string `json:"EXPORT"`
        	AssignedByID b24.ID `json:"ASSIGNED_BY_ID"`
        	DateCreate   string `json:"DATE_CREATE"`
        }
        if err := json.Unmarshal(res.Result, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID, it.Name)
        }
        
        // Total and Next are filled in by list methods; for a full
        // list traversal, use client.Core().Pages and Scan.
        if res.Total != nil {
        	fmt.Println("total:", *res.Total)
        }
        

Response Handling

HTTP Status: 200

{
        	"result": [
        		{
        			"ID": "75",
        			"NAME": "Anastasia",
        			"LAST_NAME": "Ilyina",
        			"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": "Artem",
        			"LAST_NAME": "Isaev",
        			"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": "Artem",
        			"LAST_NAME": "Isaev",
        			"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": "Inna",
        			"LAST_NAME": "Kuznetsova",
        			"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": "Ivan",
        			"LAST_NAME": "Petrov",
        			"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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Value

Empty value

Access denied

The user does not have permission for "Read" contacts

Empty value

Parameter 'order' must be array

A non-array value was passed to the order parameter

Empty value

Parameter 'filter' must be array

A non-array value was passed to the filter parameter

Empty value

Failed to get list. General error

An unknown error occurred

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

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. 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