Получить список моих компаний с реквизитами и контактами v 3.0 crm.mycompany.basic.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: пользователь с правом на чтение компаний, счетов, документов CRM или документов КЭДО — достаточно права на любой из этих типов объектов

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод crm.mycompany.basic.list возвращает список моих компаний с основными данными: названием, телефонами, почтой, реквизитами и банковскими реквизитами.

Метод доступен без прав администратора CRM, которые нужны методу crm.mycompany.list. Например, список своих компаний получит сотрудник, который работает только со счетами или документами.

Отличия от crm.mycompany.list

Что сравниваем

crm.mycompany.basic.list

crm.mycompany.list

Кто может вызвать

Пользователь с правом на чтение компаний, счетов, документов CRM или документов КЭДО

Администратор CRM

Поля

Только id, title, email, phone, requisites, bankRequisites

Все поля моей компании, кроме реквизитов, включая пользовательские поля. Поля моей компании

Ответ без select

id и title

Только id

Фильтр

Только операторы = и in, поля id, title, email.value, phone.value. Без отрицания

Операторы и поля из описания crm.<тип>.list

Сортировка

Только по id и title

По полям с признаком sortable

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

select
array

Список полей, которые нужно вернуть для каждой компании. Описание параметра

По умолчанию: ["id", "title"]

filter
array

Условия отбора компаний. Описание параметра

Если параметр не передан, метод возвращает все мои компании

order
object

Сортировка в формате {"поле": "направление"}. Описание параметра

По умолчанию: {"id": "ASC"}

pagination
object

Параметры постраничной навигации: limit, page, offset. Описание параметра

По умолчанию метод возвращает первые 50 компаний

Параметр select

Доступные поля:

  • id — идентификатор компании
  • title — название компании
  • email — адреса почты
  • phone — телефоны
  • requisites — реквизиты компании
  • bankRequisites — банковские реквизиты компании

Поля вложенных объектов можно выбрать через точку: phone.value, requisites.inn, bankRequisites.bankName. Имя объекта целиком, например requisites, возвращает все его поля.

Другие поля, например createdTime, вызывают ошибку BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION. Описания доступных полей возвращают методы crm.mycompany.basic.field.list и crm.mycompany.basic.field.get.

Параметр filter

Фильтр — массив условий в формате REST 3.0, условия соединяются логикой И:

  • ["поле", значение] — точное совпадение, для значения-массива — вхождение в список
  • ["поле", "=", значение] — точное совпадение
  • ["поле", "in", [значение, значение]] — вхождение в список

Фильтровать можно по полям:

  • id — идентификатор компании
  • title — название компании, точное совпадение
  • email.value — адрес почты
  • phone.value — номер телефона

Другие операторы, например >= или !=, вызывают ошибку BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION. Условия по реквизитам, например requisites.inn, вызывают ту же ошибку.

Условия можно соединить логикой ИЛИ группой {"logic": "or", "conditions": [...]}. Группа с "negative": true вызывает ошибку BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION. Подробнее о группах условий — в описании метода crm.<тип>.list.

Фильтр ищет только среди моих компаний: условие по идентификатору обычной компании возвращает пустой список.

Параметр order

Объект, где ключ — id или title, а значение — направление сортировки.

Возможные значения направления:

  • ASC — по возрастанию
  • DESC — по убыванию

Если id нет в order, метод добавляет его последним ключом с тем же направлением, что у последнего поля. Сортировка по другим полям вызывает ошибку.

Параметр pagination

Название
тип

Описание

limit
integer

Количество компаний на странице. Ноль и отрицательное значение вызывают ошибку.

По умолчанию: 50

page
integer

Номер страницы, начиная с 1. Смещение вычисляется как (page - 1) × limit

offset
integer

Количество компаний, которые нужно пропустить от начала списка. Отрицательное значение вызывает ошибку.

По умолчанию: 0

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.mycompany.basic.list

Примеры получают две мои компании по идентификаторам с телефонами, почтой, реквизитами и названиями банков. Компании отсортированы по названию.

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","title","phone","email","requisites.id","requisites.presetId","bankRequisites.id","bankRequisites.bankName"],"filter":[["id","in",[3,79]]],"order":{"title":"ASC"},"pagination":{"limit":10}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.mycompany.basic.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","title","phone","email","requisites.id","requisites.presetId","bankRequisites.id","bankRequisites.bankName"],"filter":[["id","in",[3,79]]],"order":{"title":"ASC"},"pagination":{"limit":10},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.mycompany.basic.list

Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make: такой вызов вернет ошибку SDK JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(ApiVersion.v3).call.

import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type Multifield = {
  id: number
  valueTypeId: string
  value: string
}

type MyCompanyBasicListResult = {
  items: {
    id: number
    title: string
    phone: Multifield[]
    email: Multifield[]
    requisites: { id: number, presetId: number }[]
    bankRequisites: { id: number, bankName: string | null }[]
  }[]
}

try {
  const response = await $b24.getHttpClient(ApiVersion.v3).call<MyCompanyBasicListResult>(
    'crm.mycompany.basic.list',
    {
      select: [
        'id',
        'title',
        'phone',
        'email',
        'requisites.id',
        'requisites.presetId',
        'bankRequisites.id',
        'bankRequisites.bankName',
      ],
      filter: [
        ['id', 'in', [3, 79]],
      ],
      order: {
        title: 'ASC',
      },
      pagination: {
        limit: 10,
      },
    },
    Text.getUuidRfc4122()
  )

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    for (const company of response.getData()!.result.items) {
      console.info(company.id, company.title, company.requisites.length)
    }
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(B24Js.ApiVersion.v3).call.

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function listMyCompanies() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
        'crm.mycompany.basic.list',
        {
          select: [
            'id',
            'title',
            'phone',
            'email',
            'requisites.id',
            'requisites.presetId',
            'bankRequisites.id',
            'bankRequisites.bankName',
          ],
          filter: [
            ['id', 'in', [3, 79]],
          ],
          order: {
            title: 'ASC',
          },
          pagination: {
            limit: 10,
          },
        },
        B24Js.Text.getUuidRfc4122()
      )

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      for (const company of response.getData().result.items) {
        console.info(company.id, company.title, company.requisites.length)
      }
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', listMyCompanies)
</script>

У методов CRM нет готовых оберток в b24pysdk, и SDK отправляет в REST 3.0 только методы из списка Config().api_v3_methods. Добавьте метод в этот список и вызовите его через bitrix_token.call_method с prefer_version=3.

from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError

method = "crm.mycompany.basic.list"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})

try:
    response = bitrix_token.call_method(
        api_method=method,
        params={
            "select": [
                "id",
                "title",
                "phone",
                "email",
                "requisites.id",
                "requisites.presetId",
                "bankRequisites.id",
                "bankRequisites.bankName",
            ],
            "filter": [
                ["id", "in", [3, 79]],
            ],
            "order": {
                "title": "ASC",
            },
            "pagination": {
                "limit": 10,
            },
        },
        prefer_version=3,
    )
    for company in response["result"]["items"]:
        print(company["id"], company["title"], len(company["requisites"]))
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"code: {error.code}",
        f"message: {error.error.message}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'crm.mycompany.basic.list',
            [
                'select' => [
                    'id',
                    'title',
                    'phone',
                    'email',
                    'requisites.id',
                    'requisites.presetId',
                    'bankRequisites.id',
                    'bankRequisites.bankName',
                ],
                'filter' => [
                    ['id', 'in', [3, 79]],
                ],
                'order' => [
                    'title' => 'ASC',
                ],
                'pagination' => [
                    'limit' => 10,
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'crm.mycompany.basic.list',
    {
        select: [
            'id',
            'title',
            'phone',
            'email',
            'requisites.id',
            'requisites.presetId',
            'bankRequisites.id',
            'bankRequisites.bankName',
        ],
        filter: [
            ['id', 'in', [3, 79]],
        ],
        order: {
            title: 'ASC',
        },
        pagination: {
            limit: 10,
        },
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'crm.mycompany.basic.list',
    [
        'select' => [
            'id',
            'title',
            'phone',
            'email',
            'requisites.id',
            'requisites.presetId',
            'bankRequisites.id',
            'bankRequisites.bankName',
        ],
        'filter' => [
            ['id', 'in', [3, 79]],
        ],
        'order' => [
            'title' => 'ASC',
        ],
        'pagination' => [
            'limit' => 10,
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.mycompany.basic.list", b24.Params{
	"select": []string{
		"id", "title", "phone", "email",
		"requisites.id", "requisites.presetId",
		"bankRequisites.id", "bankRequisites.bankName",
	},
	"filter": []any{
		[]any{"id", "in", []int{3, 79}},
	},
	"order": b24.Params{
		"title": "ASC",
	},
	"pagination": b24.Params{
		"limit": 10,
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.mycompany.basic.list: %w", err)
}

raw, ok := b24.Unwrap(res.Result, "items")
if !ok {
	return fmt.Errorf("в ответе нет ключа items")
}

var companies []struct {
	ID         int    `json:"id"`
	Title      string `json:"title"`
	Requisites []struct {
		ID       int `json:"id"`
		PresetID int `json:"presetId"`
	} `json:"requisites"`
}
if err := json.Unmarshal(raw, &companies); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, company := range companies {
	fmt.Println(company.ID, company.Title, len(company.Requisites))
}

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "id": 3,
                "title": "ООО Ромашка",
                "email": [
                    {
                        "id": 7605,
                        "valueTypeId": "WORK",
                        "valueType": {
                            "id": "WORK",
                            "name": "Рабочий e-mail",
                            "nameShort": "Рабочий"
                        },
                        "value": "info@example.com"
                    }
                ],
                "phone": [
                    {
                        "id": 7637,
                        "valueTypeId": "WORK",
                        "valueType": {
                            "id": "WORK",
                            "name": "Рабочий телефон",
                            "nameShort": "Рабочий"
                        },
                        "value": "+79990000000"
                    }
                ],
                "requisites": [
                    {
                        "id": 3,
                        "presetId": 1
                    },
                    {
                        "id": 49,
                        "presetId": 1
                    }
                ],
                "bankRequisites": [
                    {
                        "id": 3,
                        "bankName": "Основной счет"
                    }
                ]
            },
            {
                "id": 79,
                "title": "ООО Ландыш",
                "email": [],
                "phone": [],
                "requisites": [
                    {
                        "id": 97,
                        "presetId": 1
                    }
                ],
                "bankRequisites": []
            }
        ]
    },
    "time": {
        "start": 1793707015,
        "finish": 1793707015.500961,
        "duration": 0.5009610652923584,
        "processing": 0,
        "date_start": "2026-11-03T14:56:55+03:00",
        "date_finish": "2026-11-03T14:56:55+03:00",
        "operating_reset_at": 1793707560,
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Объект с данными ответа

result.items
array

Список моих компаний. Каждая компания содержит только поля из select. Поля компании описаны в методе crm.mycompany.basic.get

time
time

Информация о времени выполнения запроса

Ответ не содержит общего количества компаний. Если на странице вернулось меньше компаний, чем указано в limit, это последняя страница.

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION",
        "message": "Не удается распознать выражение фильтра `[\"id\",\">=\",3]`"
    }
}

Название
тип

Описание

error.code
string

Строковый код ошибки. Используйте для идентификации типа исключения

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибка фильтра

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Поле

Описание ошибки

Как исправить

-

Не удается распознать выражение фильтра #CONDITION#

Используйте только операторы = и in, поля id, title, email.value, phone.value и группы без negative

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

Описание ошибки

Как исправить

-

Неизвестное поле #FIELD# для сущности BasicCompanyDto

Передайте в select, filter и order только поля из описания параметров

Ошибка сортировки

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDORDEREXCEPTION, HTTP-статус: 400

Поле

Описание ошибки

Как исправить

-

Не удается распознать выражение сортировки #DIRECTION#

Передайте order объектом, например {"title":"ASC"}, с направлением ASC или DESC

Поле не участвует в сортировке

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION, HTTP-статус: 400

Поле

Описание ошибки

Как исправить

#FIELD#

В DTO BasicCompanyDto в поле #FIELD# требуется наличие атрибута Sortable для такого запроса

Сортируйте только по id или title

Ошибка пагинации

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION

Поле

Описание ошибки

Как исправить

-

Не удается распознать параметр пагинации #PAGINATION#

Передайте limit больше нуля и offset не меньше нуля

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле

Описание ошибки

Как исправить

-

Доступ запрещен

У пользователя нет права на чтение ни компаний, ни счетов, ни документов CRM, ни документов КЭДО

Метод не найден

Код ошибки: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP-статус 404

Поле

Описание ошибки

Как исправить

-

Метод #METHOD# не найден

Проверьте имя метода: оно пишется в нижнем регистре, crm.mycompany.basic.list, а не crm.myCompany.basic.list

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение