Для AI-агентов: markdown этой страницы — /docs-content/entities/requisite-presets/list.md индекс документации — /llms.txt

Список шаблонов реквизитов

GET /v1/requisite-presets

Возвращает список шаблонов реквизитов с поддержкой фильтрации, сортировки и авто-пагинации. Используется для получения доступных шаблонов наборов полей перед созданием реквизита.

Параметры

Параметр Тип По умолч. Описание
Параметрlimit Типnumber По умолч.50 ОписаниеКоличество записей (до 5000). При limit > 50 Вайбкод автоматически запрашивает несколько страниц у Битрикс24
Параметрoffset Типnumber По умолч.0 ОписаниеПропустить N записей. При offset > 0 рекомендуется limit ≤ 500
Параметрselect Типstring По умолч.— ОписаниеВыборка полей: ?select=id,name,active
Параметрsort Типstring По умолч.— ОписаниеСортировка кратким синтаксисом: ?sort=-sort, минус означает убывание. Для идентификатора — ?sort=-id; форма ID тоже принимается
Параметрorder Типobject По умолч.— ОписаниеСортировка: ?order[sort]=asc, ?order[name]=desc. Для идентификатора используйте ?order[id]=desc; форма ?order[ID]=desc тоже принимается
Параметрfilter Типobject По умолч.— ОписаниеФильтрация по полям GET /v1/requisite-presets/fields.
Синтаксис фильтрации. Пример: ?filter[active]=true&filter[countryId]=1

Пагинация

При limit > 50 Вайбкод автоматически пагинирует запрос на стороне сервера. Максимум — 5000 записей за вызов. Если под фильтр попадает больше, в meta.hasMore придёт true.

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/requisite-presets" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/requisite-presets" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisite-presets', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} шаблонов`)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisite-presets', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типarray ОписаниеМассив шаблонов (все поля — см. Поля шаблонов реквизитов)
Полеmeta.total Типnumber ОписаниеОбщее количество записей, соответствующих фильтру
Полеmeta.hasMore Типboolean ОписаниеЕсть ли ещё записи за пределами limit

Пример ответа

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "entityTypeId": 8,
      "countryId": 1,
      "name": "Организация",
      "createdAt": "2020-04-20T10:47:23.000Z",
      "updatedAt": "2021-08-13T14:34:26.000Z",
      "createdBy": 0,
      "modifyBy": 1,
      "active": true,
      "sort": 510,
      "xmlId": "#CRM_REQUISITE_PRESET_DEF_RU_COMPANY#"
    },
    {
      "id": 3,
      "entityTypeId": 8,
      "countryId": 1,
      "name": "ИП",
      "createdAt": "2020-04-20T10:47:23.000Z",
      "updatedAt": "2021-07-20T14:39:09.000Z",
      "createdBy": 0,
      "modifyBy": 1,
      "active": false,
      "sort": 520,
      "xmlId": "#CRM_REQUISITE_PRESET_DEF_RU_INDIVIDUAL#"
    },
    {
      "id": 5,
      "entityTypeId": 8,
      "countryId": 1,
      "name": "Физ. лицо",
      "createdAt": "2020-04-20T10:47:23.000Z",
      "updatedAt": "2021-08-13T14:34:34.000Z",
      "createdBy": 0,
      "modifyBy": null,
      "active": true,
      "sort": 530,
      "xmlId": "#CRM_REQUISITE_PRESET_DEF_RU_PERSON#"
    }
  ],
  "meta": {
    "total": 14,
    "hasMore": false
  }
}

Пример ответа при ошибке

403 — нет скоупа:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}

Ошибки

HTTP Код Описание
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа crm
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов
HTTP400 КодINVALID_FILTER ОписаниеОшибка в синтаксисе фильтра
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Действующее значение — в заголовке x-ratelimit-limit. Повторите после срока из заголовка Retry-After

Полный список общих ошибок API — Ошибки.

Известные особенности

Поле entityTypeId всегда равно 8. Все шаблоны относятся к типу сущности «реквизит» — entityTypeId: 8. Значение не изменяется и не передаётся в фильтре как различающий признак.

Поле countryId. Российские шаблоны имеют countryId: 1. На портале с региональными шаблонами (Казахстан, Украина, Польша и др.) в списке появятся шаблоны с другими значениями.

Неактивные шаблоны включаются в список. Шаблон с active: false возвращается в списке по умолчанию. Чтобы получить только активные шаблоны, передайте filter[active]=true.

Смотрите также