Get a List of Companies by Filter crm.company.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:
crmWho can execute the method: user with "Read" access permission for companies
DEPRECATED
The development of this method has been halted. Please use 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 |
Description |
|
select |
List of fields to limit the selection. You can use masks for selection:
There is no mask for selecting multiple fields. To select multiple fields, specify the required ones in the selection list — You can find the list of available fields for selection using the crm.company.fields method. By default, all fields are returned — |
|
filter |
Object format:
where:
You can add a prefix to the keys
Fields The You can find the list of available fields for filtering using the crm.company.fields method. The |
|
order |
Object format:
where:
You can find the list of available fields for sorting using the crm.company.fields method |
|
start |
Parameter for managing pagination. The page size of results is always static — 50 records. To select the second page of results, pass the value The formula for calculating the
|
Code Examples
How to Use Examples in Documentation
Retrieve companies:
- sorted by creation date,
- with selected fields: title, responsible person, phone,
- filtered by company type
CUSTOMERand creation date from 2025-01-01.
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
// 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 each company object returned in result[]
type CrmCompanyListItem = {
ID: string
TITLE: string
ASSIGNED_BY_ID: string
PHONE?: CrmCompanyPhone[]
}
type CrmCompanyPhone = {
ID: string
VALUE_TYPE: string
VALUE: string
TYPE_ID: string
}
try {
// crm.company.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<CrmCompanyListItem[]>({
method: 'crm.company.list',
params: {
order: { DATE_CREATE: 'ASC' },
filter: { COMPANY_TYPE: 'CUSTOMER', '>=DATE_CREATE': '2025-01-01' },
select: ['TITLE', 'ASSIGNED_BY_ID', 'PHONE'],
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('Companies 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 listCompanies() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.company.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.company.list',
params: {
order: { DATE_CREATE: 'ASC' },
filter: { COMPANY_TYPE: 'CUSTOMER', '>=DATE_CREATE': '2025-01-01' },
select: ['TITLE', 'ASSIGNED_BY_ID', 'PHONE'],
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('Companies on this page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listCompanies)
</script>
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 |
Description |
|
result |
Array of companies matching the filter. The format of the returned data depends on the |
|
total |
Total number of companies found |
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "Access denied."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
|
The user does not have "Read" access permission for companies |
|
|
|
The |
|
|
|
The |
|
|
|
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 |
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 |