crm.requisite.list
Получить список реквизитов по фильтру
Описание
Метод получает список реквизитов по фильтру.
Параметры
select
array
необязательный
Массив содержит список полей, которые необходимо выбрать (смотрите поля реквизита).
Если не передан или передан пустой массив, то будут выбраны все доступные поля реквизитов
filter
object
необязательный
Объект для фильтрации выбранных реквизитов в формате {"field_1": "value_1", ... "field_N": "value_N"}.
Возможные значения для field соответствуют полям реквизита.
Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
>=— больше либо равно>— больше<=— меньше либо равно<— меньше@— IN (в качестве значения передаётся массив)!@— NOT IN (в качестве значения передаётся массив)%— LIKE, поиск по подстроке. Символ%в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки=%— LIKE, поиск по подстроке. Символ%нужно передавать в значении. Примеры:
- "мол%" — ищем значения, начинающиеся с «мол»
- "%мол" — ищем значения, заканчивающиеся на «мол»
- "%мол%" — ищем значения, где «мол» может быть в любой позиции%=— LIKE (см. описание выше)!%— NOT LIKE, поиск по подстроке. Символ%в значении фильтра передавать не нужно. Поиск идет с обоих сторон.!=%— NOT LIKE, поиск по подстроке. Символ%нужно передавать в значении. Примеры:
- "мол%" — ищем значения, не начинающиеся с «мол»
- "%мол" — ищем значения, не заканчивающиеся на «мол»
- "%мол%" — ищем значения, где подстроки «мол» нет в любой позиции!%=— NOT LIKE (см. описание выше)=— равно, точное совпадение (используется по умолчанию)!=— не равно!— не равно
order
object
необязательный
Объект для сортировки выбранных реквизитов в формате {"field_1": "order_1", ... "field_N": "order_N"}.
Возможные значения для field соответствуют полям реквизита.
Возможные значения для order:
asc— в порядке возрастанияdesc— в порядке убывания
start
integer
необязательный
Параметр используется для управления постраничной навигацией.
Размер страницы результатов всегда статичный: 50 записей.
Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее.
Формула расчета значения параметра start:
start = (N-1) * 50, где N — номер нужной страницы
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"DATE_CREATE":"ASC"},"filter":{"PRESET_ID":"1"},"select":["ENTITY_TYPE_ID","ENTITY_ID","ID","NAME"]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"DATE_CREATE":"ASC"},"filter":{"PRESET_ID":"1"},"select":["ENTITY_TYPE_ID","ENTITY_ID","ID","NAME"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.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 RequisiteResult returned in result[]
type RequisiteResult = {
ENTITY_TYPE_ID: string
ENTITY_ID: string
ID: string
NAME: string
}
try {
// crm.requisite.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<RequisiteResult[]>({
method: 'crm.requisite.list',
params: {
order: { DATE_CREATE: 'ASC' },
filter: { PRESET_ID: '1' },
select: ['ENTITY_TYPE_ID', 'ENTITY_ID', 'ID', 'NAME'],
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('Requisites:', 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 getRequisiteList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.requisite.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.requisite.list',
params: {
order: { DATE_CREATE: 'ASC' },
filter: { PRESET_ID: '1' },
select: ['ENTITY_TYPE_ID', 'ENTITY_ID', 'ID', 'NAME'],
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('Requisites:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getRequisiteList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.list(
order={
"DATE_CREATE": "ASC",
},
filter={
"PRESET_ID": "1",
},
select=[
"ENTITY_TYPE_ID",
"ENTITY_ID",
"ID",
"NAME",
],
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.requisite.list(
order={
"DATE_CREATE": "ASC",
},
filter={
"PRESET_ID": "1",
},
select=[
"ENTITY_TYPE_ID",
"ENTITY_ID",
"ID",
"NAME",
],
).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.requisite.list(
filter={
"PRESET_ID": "1",
},
select=[
"ENTITY_TYPE_ID",
"ENTITY_ID",
"ID",
"NAME",
],
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}")
require_once('crest.php');
$result = CRest::call(
'crm.requisite.list',
[
'order' => ["DATE_CREATE" => "ASC"],
'filter' => ["PRESET_ID" => "1"],
'select' => ["ENTITY_TYPE_ID", "ENTITY_ID", "ID", "NAME"]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Ответ
HTTP-статус: 200
{
"result": [
{
"ENTITY_TYPE_ID": "4",
"ENTITY_ID": "3027",
"ID": "40",
"NAME": "Организация"
},
{
"ENTITY_TYPE_ID": "4",
"ENTITY_ID": "3028",
"ID": "41",
"NAME": "Реквизиты головного офиса"
},
{
"ENTITY_TYPE_ID": "4",
"ENTITY_ID": "3028",
"ID": "42",
"NAME": "Филиал в г. Черняховск"
}
],
"total": 3,
"time": {
"start": 1717150154.197056,
"finish": 1717150154.505106,
"duration": 0.30804991722106934,
"processing": 0.030454158782958984,
"date_start": "2024-05-31T12:09:14+02:00",
"date_finish": "2024-05-31T12:09:14+02:00",
"operating": 0
}
}
Возвращаемые данные
result
array
Массив объектов с информацией из выбранных реквизитов. Каждый элемент содержит выбранные поля реквизита
total
integer
Общее количество найденных записей
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": 0,
"error_description": "Access denied."
}
| Код | Описание | Значение |
|---|---|---|
0 |
Access denied. | Недостаточно прав доступа для получения списка реквизитов |

