Получить список сделок crm.deal.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: любой пользователь с правом «чтения» сделок
DEPRECATED
Развитие метода остановлено. Используйте crm.item.list.
Метод crm.deal.list возвращает список сделок по фильтру. Является реализацией списочного метода для сделок.
Параметры метода
|
Название |
Описание |
|
select |
Список полей, которые должны быть заполнены у сделок в выборке. При выборке можно использовать следующие маски:
Список доступных полей для выборки можно узнать с помощью метода crm.deal.fields. По умолчанию берутся все поля — |
|
filter |
Объект формата:
где:
К ключам
Фильтр LIKE не работает с полями типа Список доступных полей для фильтрации можно узнать с помощью метода crm.deal.fields. Фильтр не поддерживает поле |
|
order |
Объект формата:
где:
Список доступных полей для сортировки можно узнать с помощью метода crm.deal.fields |
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
|
Так же смотрите описание списочных методов.
Связанные методы и темы
Примеры кода
Как использовать примеры в документации
Получить список сделок, у которых:
- идентификатор воронки равен
1 - тип сделки равен
COMPLEX(комплексная продажа) - название заканчивается на
а - стадия равна
С1:NEW(новая) - сумма больше 10000, но меньше или равна 20000
- включен ручной режим подсчета суммы
- ответственным является либо пользователь с
id = 1, либо пользователь сid = 6 - сделка создана не менее 6 месяцев назад
Задать следующий порядок сортировки у данной выборки: название и сумма в порядке возрастания.
Для наглядности выбрать только необходимые поля:
- Идентификатор
ID - Название
TITLE - Тип сделки
TYPE_ID - Идентификатор воронки
CATEGORY_ID - Стадия
STAGE_ID - Сумма
OPPORTUNITY - Включен ли ручной режим
IS_MANUAL_OPPORTUNITY - Ответственный
ASSIGNED_BY_ID - Дата создания
DATE_CREATE
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"SELECT":["ID","TITLE","TYPE_ID","CATEGORY_ID","STAGE_ID","OPPORTUNITY","IS_MANUAL_OPPORTUNITY","ASSIGNED_BY_ID","DATE_CREATE"],"FILTER":{"=%TITLE":"%а","CATEGORY_ID":1,"TYPE_ID":"COMPLEX","STAGE_ID":"C1:NEW",">OPPORTUNITY":10000,"<=OPPORTUNITY":20000,"IS_MANUAL_OPPORTUNITY":"Y","@ASSIGNED_BY_ID":[1,6],">DATE_CREATE":"'"$(date --date='-6 months' +%Y-%m-%d)"'"},"ORDER":{"TITLE":"ASC","OPPORTUNITY":"ASC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"SELECT":["ID","TITLE","TYPE_ID","CATEGORY_ID","STAGE_ID","OPPORTUNITY","IS_MANUAL_OPPORTUNITY","ASSIGNED_BY_ID","DATE_CREATE"],"FILTER":{"=%TITLE":"%а","CATEGORY_ID":1,"TYPE_ID":"COMPLEX","STAGE_ID":"C1:NEW",">OPPORTUNITY":10000,"<=OPPORTUNITY":20000,"IS_MANUAL_OPPORTUNITY":"Y","@ASSIGNED_BY_ID":[1,6],">DATE_CREATE":"'"$(date --date='-6 months' +%Y-%m-%d)"'"},"ORDER":{"TITLE":"ASC","OPPORTUNITY":"ASC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.deal.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 deal returned in result[] (subset shaped by `select`)
type CrmDealListItem = {
ID: string
TITLE: string
TYPE_ID: string
CATEGORY_ID: string
STAGE_ID: string
OPPORTUNITY: string
IS_MANUAL_OPPORTUNITY: string
ASSIGNED_BY_ID: string
DATE_CREATE: ISODate | null
}
const now = new Date()
const sixMonthAgo = new Date()
sixMonthAgo.setMonth(now.getMonth() - 6)
try {
// crm.deal.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<CrmDealListItem[]>({
method: 'crm.deal.list',
params: {
select: [
'ID',
'TITLE',
'TYPE_ID',
'CATEGORY_ID',
'STAGE_ID',
'OPPORTUNITY',
'IS_MANUAL_OPPORTUNITY',
'ASSIGNED_BY_ID',
'DATE_CREATE',
],
filter: {
'=%TITLE': '%а',
CATEGORY_ID: 1,
TYPE_ID: 'COMPLEX',
STAGE_ID: 'C1:NEW',
'>OPPORTUNITY': 10000,
'<=OPPORTUNITY': 20000,
IS_MANUAL_OPPORTUNITY: 'Y',
'@ASSIGNED_BY_ID': [1, 6],
'>DATE_CREATE': sixMonthAgo,
},
order: {
TITLE: 'ASC',
OPPORTUNITY: 'ASC',
},
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('Deals 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 listDeals() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const now = new Date()
const sixMonthAgo = new Date()
sixMonthAgo.setMonth(now.getMonth() - 6)
// crm.deal.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.deal.list',
params: {
select: [
'ID',
'TITLE',
'TYPE_ID',
'CATEGORY_ID',
'STAGE_ID',
'OPPORTUNITY',
'IS_MANUAL_OPPORTUNITY',
'ASSIGNED_BY_ID',
'DATE_CREATE',
],
filter: {
'=%TITLE': '%а',
CATEGORY_ID: 1,
TYPE_ID: 'COMPLEX',
STAGE_ID: 'C1:NEW',
'>OPPORTUNITY': 10000,
'<=OPPORTUNITY': 20000,
IS_MANUAL_OPPORTUNITY: 'Y',
'@ASSIGNED_BY_ID': [1, 6],
'>DATE_CREATE': sixMonthAgo,
},
order: {
TITLE: 'ASC',
OPPORTUNITY: 'ASC',
},
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('Deals on this page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listDeals)
</script>
try {
$response = $b24Service
->core
->call(
'crm.deal.list',
[
'select' => [
'ID',
'TITLE',
'TYPE_ID',
'CATEGORY_ID',
'STAGE_ID',
'OPPORTUNITY',
'IS_MANUAL_OPPORTUNITY',
'ASSIGNED_BY_ID',
'DATE_CREATE',
],
'filter' => [
'=%TITLE' => '%а',
'CATEGORY_ID' => 1,
'TYPE_ID' => 'COMPLEX',
'STAGE_ID' => 'C1:NEW',
'>OPPORTUNITY' => 10000,
'<=OPPORTUNITY' => 20000,
'IS_MANUAL_OPPORTUNITY' => 'Y',
'@ASSIGNED_BY_ID' => [1, 6],
'>DATE_CREATE' => $sixMonthAgo,
],
'order' => [
'TITLE' => 'ASC',
'OPPORTUNITY' => 'ASC',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching deal list: ' . $e->getMessage();
}
const now = new Date();
const sixMonthAgo = new Date();
sixMonthAgo.setMonth(now.getMonth() - 6);
BX24.callMethod(
'crm.deal.list',
{
select: [
'ID',
'TITLE',
'TYPE_ID',
'CATEGORY_ID',
'STAGE_ID',
'OPPORTUNITY',
'IS_MANUAL_OPPORTUNITY',
'ASSIGNED_BY_ID',
'DATE_CREATE',
],
filter: {
'=%TITLE': '%а',
CATEGORY_ID: 1,
TYPE_ID: 'COMPLEX',
STAGE_ID: 'C1:NEW',
'>OPPORTUNITY': 10000,
'<=OPPORTUNITY': 20000,
IS_MANUAL_OPPORTUNITY: 'Y',
'@ASSIGNED_BY_ID': [1, 6],
'>DATE_CREATE': sixMonthAgo,
},
order: {
TITLE: 'ASC',
OPPORTUNITY: 'ASC',
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$sixMonthAgo = (new DateTime())->modify('-6 months')->format('Y-m-d');
$result = CRest::call(
'crm.deal.list',
[
'SELECT' => [
'ID',
'TITLE',
'TYPE_ID',
'CATEGORY_ID',
'STAGE_ID',
'OPPORTUNITY',
'IS_MANUAL_OPPORTUNITY',
'ASSIGNED_BY_ID',
'DATE_CREATE',
],
'FILTER' => [
'=%TITLE' => '%а',
'CATEGORY_ID' => 1,
'TYPE_ID' => 'COMPLEX',
'STAGE_ID' => 'C1:NEW',
'>OPPORTUNITY' => 10000,
'<=OPPORTUNITY' => 20000,
'IS_MANUAL_OPPORTUNITY' => 'Y',
'@ASSIGNED_BY_ID' => [1, 6],
'>DATE_CREATE' => $sixMonthAgo,
],
'ORDER' => [
'TITLE' => 'ASC',
'OPPORTUNITY' => 'ASC',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Пример
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.deal.list(
select=["ID", "TITLE", "STAGE_ID", "OPPORTUNITY", "ASSIGNED_BY_ID", "DATE_CREATE"],
filter={">OPPORTUNITY": 1000, "!STAGE_ID": "WON", "=OPENED": "Y"},
order={"DATE_CREATE": "DESC", "ID": "DESC"},
start=0,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
Пример as_list
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.deal.list(
select=["ID", "TITLE", "STAGE_ID"],
filter={"!STAGE_ID": "LOSE"},
order={"ID": "ASC"},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
Пример as_list_fast
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.deal.list(
select=["ID", "TITLE", "STAGE_ID"],
filter={"!STAGE_ID": "LOSE"},
order={"ID": "DESC"},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"ID": "37",
"TITLE": "[А] Сделка",
"TYPE_ID": "COMPLEX",
"CATEGORY_ID": "1",
"STAGE_ID": "C1:NEW",
"OPPORTUNITY": "19999.99",
"IS_MANUAL_OPPORTUNITY": "Y",
"ASSIGNED_BY_ID": "1",
"DATE_CREATE": "2024-09-02T18:37:18+02:00"
},
{
"ID": "38",
"TITLE": "[А] Сделка",
"TYPE_ID": "COMPLEX",
"CATEGORY_ID": "1",
"STAGE_ID": "C1:NEW",
"OPPORTUNITY": "20000.00",
"IS_MANUAL_OPPORTUNITY": "Y",
"ASSIGNED_BY_ID": "6",
"DATE_CREATE": "2024-09-02T18:37:38+02:00"
},
{
"ID": "39",
"TITLE": "[Б] Продажа",
"TYPE_ID": "COMPLEX",
"CATEGORY_ID": "1",
"STAGE_ID": "C1:NEW",
"OPPORTUNITY": "12500.00",
"IS_MANUAL_OPPORTUNITY": "Y",
"ASSIGNED_BY_ID": "1",
"DATE_CREATE": "2024-04-09T23:11:01+02:00"
},
{
"ID": "40",
"TITLE": "[Б] Сделка",
"TYPE_ID": "COMPLEX",
"CATEGORY_ID": "1",
"STAGE_ID": "C1:NEW",
"OPPORTUNITY": "13500.00",
"IS_MANUAL_OPPORTUNITY": "Y",
"ASSIGNED_BY_ID": "6",
"DATE_CREATE": "2024-08-08T19:00:14+02:00"
},
{
"ID": "41",
"TITLE": "[В] Сделка",
"TYPE_ID": "COMPLEX",
"CATEGORY_ID": "1",
"STAGE_ID": "C1:NEW",
"OPPORTUNITY": "11500.00",
"IS_MANUAL_OPPORTUNITY": "Y",
"ASSIGNED_BY_ID": "6",
"DATE_CREATE": "2024-05-08T09:38:23+02:00"
},
{
"ID": "42",
"TITLE": "[С] Сделка",
"TYPE_ID": "COMPLEX",
"CATEGORY_ID": "1",
"STAGE_ID": "C1:NEW",
"OPPORTUNITY": "18500.00",
"IS_MANUAL_OPPORTUNITY": "Y",
"ASSIGNED_BY_ID": "6",
"DATE_CREATE": "2024-07-02T15:38:32+02:00"
}
],
"total": 6,
"time": {
"start": 1725292115.026221,
"finish": 1725292115.907058,
"duration": 0.8808369636535645,
"processing": 0.2484450340270996,
"date_start": "2024-09-02T17:48:35+02:00",
"date_finish": "2024-09-02T17:48:35+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Содержит массив из объектов, содержащих информацию о полях сделок. Стоит учитывать, что структура полей может быть изменена из-за параметра |
|
total |
Общее количество найденных элементов |
|
next |
Содержит значение, которое нужно передать в следующий запрос в параметр Параметр |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Parameter 'filter' must be array."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
|
У пользователя нет прав на «чтение» сделок |
|
|
|
В параметр |
|
|
|
В параметр |
|
|
|
Произошла неизвестная ошибка |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Создать новую сделку crm.deal.add
- Изменить сделку crm.deal.update
- Получить сделку по Id crm.deal.get
- Удалить сделку crm.deal.delete
- Получить поля сделки crm.deal.fields
- Добавить дело в новый лид или сделку в зависимости от режима CRM