crm.deal.list
Получить список сделок
Описание
Метод crm.deal.list возвращает список сделок по фильтру. Является реализацией списочного метода для сделок.
Параметры
select
string[]
необязательный
Список полей, которые должны быть заполнены у сделок в выборке.
При выборке можно использовать следующие маски:
- '*' — для выборки всех полей (без пользовательских и множественных)
- 'UF_*' — для выборки всех пользовательских полей (без множественных)
Список доступных полей для выборки можно узнать с помощью метода crm.deal.fields.
Метод не поддерживает поле CONTACT_IDS, для получения сделок со списком контактов используйте метод crm.item.list.
По умолчанию берутся все поля — '*' + Пользовательские поля — 'UF_*'
filter
object
необязательный
Объект формата:
{
field_1: value_1,
field_2: value_2,
...,
field_n: value_n,
}
где:
- field_n — название поля, по которому будет отфильтрована выборка элементов
- value_n — значение фильтра
К ключам field_n можно добавить префикс, уточняющий работу фильтра.
Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- @ — IN, в качестве значения передается массив
- !@ — NOT IN, в качестве значения передается массив
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, начинающиеся с «мол»
- "%мол" — ищет значения, заканчивающиеся на «мол»
- "%мол%" — ищет значения, где «мол» может быть в любой позиции
- %= — LIKE (аналогично =%)
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- ! — не равно
Фильтр LIKE не работает с полями типа crm_status, crm_contact, crm_company (тип сделки TYPE_ID, стадия STAGE_ID и так далее).
Список доступных полей для фильтрации можно узнать с помощью метода crm.deal.fields.
Фильтр не поддерживает поле CONTACT_IDS, для фильтрации по контактам используйте метод crm.item.list
order
object
необязательный
Объект формата:
{
field_1: value_1,
field_2: value_2,
...,
field_n: value_n,
}
где:
- field_n — название поля, по которому будет произведена сортировка выборки сделок
- value_n — значение типа string, равное:
- ASC — сортировка по возрастанию
- DESC — сортировка по убыванию
Список доступных полей для сортировки можно узнать с помощью метода crm.deal.fields
start
integer
необязательный
Параметр используется для управления постраничной навигацией.
Размер страницы результатов всегда статичный — 50 записей.
Чтобы выбрать вторую страницу результатов, передайте значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.
Формула расчета значения параметра start:
start = (N-1) * 50, где N — номер нужной страницы
Примеры запроса
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
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}")
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.deal.list", b24.Params{
"select": []string{"ID", "TITLE", "TYPE_ID", "CATEGORY_ID", "STAGE_ID", "OPPORTUNITY", "IS_MANUAL_OPPORTUNITY", "ASSIGNED_BY_ID", "DATE_CREATE"},
"filter": b24.Params{
"=%TITLE": "%а",
"CATEGORY_ID": 1,
"TYPE_ID": "COMPLEX",
"STAGE_ID": "C1:NEW",
">OPPORTUNITY": 10000,
"<=OPPORTUNITY": 20000,
"IS_MANUAL_OPPORTUNITY": "Y",
"@ASSIGNED_BY_ID": []int{1, 6},
">DATE_CREATE": time.Now().AddDate(0, -6, 0).Format("2006-01-02"),
},
"order": b24.Params{
"TITLE": "ASC",
"OPPORTUNITY": "ASC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.deal.list: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
Title string `json:"TITLE"`
TypeID string `json:"TYPE_ID"`
CategoryID b24.ID `json:"CATEGORY_ID"`
StageID string `json:"STAGE_ID"`
Opportunity string `json:"OPPORTUNITY"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Title)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Ответ
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
deal[]
Корневой элемент ответа. Содержит массив из объектов, содержащих информацию о полях сделок.
Стоит учитывать, что структура полей может быть изменена из-за параметра select
total
integer
Общее количество найденных элементов
next
integer
Содержит значение, которое нужно передать в следующий запрос в параметр start, чтобы получить следующую порцию данных.
Параметр next появляется в ответе, если количество элементов, соответствующих вашему запросу, превышает значение 50
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Parameter 'filter' must be array."
}
| Код | Описание | Значение |
|---|---|---|
400 |
Пустое значение | Access denied. |
400 |
Пустое значение | Parameter 'order' must be array. |
400 |
Пустое значение | Parameter 'filter' must be array. |
400 |
Пустое значение | Failed to get list. General error. |

