Get a List of Companies by Filter crm.company.list

Scope: crm

Who can execute the method: user with "Read" access permission for companies

Method development has been halted

The method crm.company.list continues to function, but there is a more current equivalent crm.item.list.

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

Method Parameters

Required parameters are marked with *

Name `type`	Description
select `string[]`	List of fields to limit the selection. You can use masks for selection: `''` — to select all fields, excluding custom and multiple fields, `'UF_'` — to select all custom fields excluding multiple ones. There are no masks for selecting multiple fields. To select multiple fields, specify the required ones in the selection list — `PHONE`, `EMAIL`, and so on. You can find the list of available fields for selection using the method crm.company.fields. By default, all fields are returned — `''` + 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 must 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`, `EMAIL`, `WEB`, `IM` are multiple. Filters work only on exact matches for them. The `LIKE` filter does not work with fields of type `crm_status`, `crm_company` — for example, `COMPANY_TYPE`. You can find the list of available fields for filtering using the method crm.company.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 companies 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.company.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 `start` parameter value: `start = (N-1) * 50`, where `N` — the number of the desired page

Code Examples

How to Use Examples in Documentation

Retrieve companies:

sorted by creation date,
with selected fields: name, responsible person, phone,
filtered by: company type CUSTOMER and creation date from 2025-01-01.

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ORDER":{"DATE_CREATE":"ASC"},"FILTER":{"COMPANY_TYPE":"CUSTOMER",">=DATE_CREATE":"2025-01-01"},"SELECT":["TITLE","ASSIGNED_BY_ID","PHONE"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ORDER":{"DATE_CREATE":"ASC"},"FILTER":{"COMPANY_TYPE":"CUSTOMER",">=DATE_CREATE":"2025-01-01"},"SELECT":["TITLE","ASSIGNED_BY_ID","PHONE"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.company.list

// callListMethod: Retrieves all data at once.
        // Use only for small selections (< 1000 items) due to high
        // memory load.
        
        try {
        const response = await $b24.callListMethod(
            'crm.company.list',
            {
            order: { "DATE_CREATE": "ASC" },
            filter: { "COMPANY_TYPE": "CUSTOMER", ">=DATE_CREATE": "2025-01-01" },
            select: [ "TITLE", "ASSIGNED_BY_ID", "PHONE" ]
            },
            (progress: number) => { console.log('Progress:', progress) }
        );
        const items = response.getData() || [];
        for (const entity of items) { console.log('Entity:', entity) }
        } catch (error: any) {
        console.error('Request failed', error)
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator.
        // Use for large volumes of data for efficient memory consumption.
        
        try {
        const generator = $b24.fetchListMethod('crm.company.list', {
            order: { "DATE_CREATE": "ASC" },
            filter: { "COMPANY_TYPE": "CUSTOMER", ">=DATE_CREATE": "2025-01-01" },
            select: [ "TITLE", "ASSIGNED_BY_ID", "PHONE" ]
        }, 'ID');
        for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
        }
        } catch (error: any) {
        console.error('Request failed', error)
        }
        
        // callMethod: Manual control of pagination through the start parameter.
        // Use for precise control over request batches.
        // Less efficient for large data than fetchListMethod.
        
        try {
        const response = await $b24.callMethod('crm.company.list', {
            order: { "DATE_CREATE": "ASC" },
            filter: { "COMPANY_TYPE": "CUSTOMER", ">=DATE_CREATE": "2025-01-01" },
            select: [ "TITLE", "ASSIGNED_BY_ID", "PHONE" ]
        }, 0);
        const result = response.getData().result || [];
        for (const entity of result) { console.log('Entity:', entity) }
        } catch (error: any) {
        console.error('Request failed', error)
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.company.list',
                    [
                        'order' => ['DATE_CREATE' => 'ASC'],
                        'filter' => ['COMPANY_TYPE' => 'CUSTOMER', '>=DATE_CREATE' => '2025-01-01'],
                        'select' => ['TITLE', 'ASSIGNED_BY_ID', 'PHONE'],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            
            if ($result->more()) {
                $result->next();
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching company list: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.company.list",
            {
                order: { "DATE_CREATE": "ASC" },
                filter: { "COMPANY_TYPE": "CUSTOMER", ">=DATE_CREATE": "2025-01-01" },
                select: [ "TITLE", "ASSIGNED_BY_ID", "PHONE" ]
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                {
                    console.dir(result.data());
                    if(result.more())
                        result.next();
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.company.list',
            [
                'order' => ['DATE_CREATE' => 'ASC'],
                'filter' => ['COMPANY_TYPE' => 'CUSTOMER', '>=DATE_CREATE' => '2025-01-01'],
                'select' => ['TITLE', 'ASSIGNED_BY_ID', 'PHONE'],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": [
                {
                    "TITLE": "Crossroads",
                    "ASSIGNED_BY_ID": "811",
                    "ID": "2919",
                    "PHONE": [
                        {
                            "ID": "8303",
                            "VALUE_TYPE": "WORK",
                            "VALUE": "+19998887766",
                            "TYPE_ID": "PHONE"
                        }
                    ]
                }
            ],
            "total": 1,
            "time": {
                "start": 1769498859,
                "finish": 1769498859.948139,
                "duration": 0.948138952255249,
                "processing": 0,
                "date_start": "2026-01-27T10:27:39+01:00",
                "date_finish": "2026-01-27T10:27:39+01:00",
                "operating_reset_at": 1769499459,
                "operating": 0.1621239185333252
            }
        }

Returned Data

Name `type`	Description
result `array[]`	Array of companies matching the filter. The format of the returned data depends on the `select` parameter
total `integer`	Total number of companies found
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 "Read" access permission for companies
`-`	`Parameter 'order' must be array`	The `order` parameter is not an array
`-`	`Parameter 'filter' must be array`	The `filter` parameter is not an array
`-`	`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

Get Information About a Company

Delete a Company

Get a List of Companies by Filter crm.company.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning