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

Получить виджеты сайта для формы

GET /v1/crm-forms/:id/site-buttons

Показывает виджеты сайта портала и их связь с выбранной CRM-формой.

Параметры

Параметр Тип Обяз. По умолч. Описание
Параметрid (path) Типnumber Обяз.да По умолч.— ОписаниеПоложительный целый ID формы. Источник: Список CRM-форм
Параметрlimit (query) Типnumber Обяз.нет По умолч.Умолчание Битрикс24 ОписаниеРазмер страницы. Значение проверяет Битрикс24
Параметрoffset (query) Типnumber Обяз.нет По умолч.Умолчание Битрикс24 ОписаниеСмещение. Значение проверяет Битрикс24
Параметрorder / sort (query) Типobject / string Обяз.нет По умолч.Умолчание Битрикс24 ОписаниеСортировка по ID: order[id]=desc или sort=-id

Пагинация: один запрос получает одну страницу. Без limit и offset действует умолчание Битрикс24. Каждый параметр можно передать отдельно. Автоматического обхода страниц нет. select не поддерживается.

Примеры

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

Terminal
curl "https://vibecode.bitrix24.tech/v1/crm-forms/91/site-buttons?sort=-id" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal
curl "https://vibecode.bitrix24.tech/v1/crm-forms/91/site-buttons?sort=-id" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-forms/91/site-buttons?sort=-id', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-forms/91/site-buttons?sort=-id', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типarray ОписаниеМассив виджетов сайта
Полеdata[].formId Типnumber ОписаниеID запрошенной формы. Источник: Список CRM-форм
Полеdata[].id Типnumber ОписаниеID виджета из этого списка
Полеdata[].name Типstring ОписаниеНазвание из Битрикс24. Заменяются только учётные данные текущего соединения с путями в meta.redacted
Полеdata[].bound Типboolean ОписаниеСвязан ли объект с запрошенной формой
Полеdata[].system Типboolean ОписаниеСистемный ли это виджет
Полеdata[].formsId Типnumber[] ОписаниеID форм, подключённых к виджету. Источник: Список CRM-форм
Полеdata[].previewUrl Типstring | null ОписаниеПубличная ссылка предпросмотра, без изменений. null, если предпросмотр недоступен
Полеmeta.limit Типnumber ОписаниеРазмер страницы, если передан в ответе Битрикс24
Полеmeta.offset Типnumber ОписаниеСмещение, если передано в ответе Битрикс24
Полеmeta.total Типnumber ОписаниеОбщее количество записей. Поле отсутствует, если источник не передал количество
Полеmeta.redacted Типstring[] ОписаниеПути с заменёнными учётными данными текущего соединения

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

Показаны первые два элемента. Публичные домены и подписи условные.

JSON
{
  "success": true,
  "data": [
    {
      "formId": 91,
      "id": 3,
      "name": "Wix",
      "system": false,
      "bound": false,
      "formsId": [
        1
      ],
      "previewUrl": "https://example.bitrix24.ru/pub/form/91/DUMMY_PUBLIC_SIGNATURE/?view=preview&preview=button&preview_id=3"
    },
    {
      "formId": 91,
      "id": 1,
      "name": "Открытая линия, CRM-форма",
      "system": true,
      "bound": false,
      "formsId": [
        3
      ],
      "previewUrl": "https://example.bitrix24.ru/pub/form/91/DUMMY_PUBLIC_SIGNATURE/?view=preview&preview=button&preview_id=1"
    }
  ]
}

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

400 — ID формы не является положительным целым числом:

JSON
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "id must be a positive safe integer"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS Описаниеid не является положительным целым числом
HTTP400 КодINVALID_PARAMS ОписаниеНеизвестный параметр строки запроса или некорректная структура order либо sort
HTTP400 КодINVALID_PARAMS ОписаниеПереданы одновременно order[...] и sort
HTTP400 КодINVALID_PARAMS ОписаниеБитрикс24 отклонил сортировку или пагинацию, например нечисловой limit или offset. Исходный код — в error.b24Code, ошибки полей — в error.validation
HTTP401 КодTOKEN_MISSING ОписаниеНе настроен доступ к Битрикс24 или не передана OAuth-сессия
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа crm
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеПользователю Битрикс24 запрещено чтение
HTTP409 КодCRM_FORM_REST_NOT_ENABLED ОписаниеREST-методы CRM-форм выключены на портале. Исходный код отсутствующего метода — в error.b24Code
HTTP403 КодBITRIX_INSUFFICIENT_SCOPE ОписаниеТокену Битрикс24 не хватает скоупа. Исходный код — в error.b24Code
HTTP404 КодENTITY_NOT_FOUND ОписаниеФорма не найдена
HTTP422 КодBITRIX_ERROR ОписаниеОтказ Битрикс24 при обработке запроса
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит запросов. Повторите после срока из Retry-After
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен или прислал некорректный ответ
HTTP503 КодBITRIX_TIMEOUT ОписаниеБитрикс24 не ответил за отведённое время. Повторите чтение после срока из Retry-After

Ошибки Битрикс24 содержат исходный error.b24Code и переданные уточнения по полям в error.validation. Общие ошибки API — Ошибки.

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

Список включает все виджеты сайта портала, в том числе с bound: false. Чтобы выбрать связанные с формой объекты, отберите элементы с bound: true в полученном массиве. Параметр bound в запросе не поддерживается.

Требуется скоуп crm. Чтение доступно ключам с режимом READONLY и не меняет настройки объектов.

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