Получить список виджетов на сайт для CRM-формы crm.form.sitebutton.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: пользователь с правом на просмотр CRM-форм и виджетов на сайт

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод crm.form.sitebutton.list возвращает виджеты на сайт и показывает, подключена ли к ним указанная CRM-форма.

Метод только читает данные: подключить форму к виджету через REST нельзя.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

filter*
array

Фильтр по CRM-форме. Принимает ровно одно условие по полю formId с оператором =:

[["formId", "=", 45]]

Другие поля, операторы, логика or и отрицание не поддерживаются.

Идентификатор формы можно получить методом crm.form.list

order
object

Сортировка по идентификатору виджета. Принимает только поле id.

Возможные значения:

  • ASC — по возрастанию
  • DESC — по убыванию

Например, {"id": "DESC"}

pagination
object

Параметры постраничной навигации:

  • limit — количество виджетов на странице, от 1 до 1000. По умолчанию — 50
  • offset — сколько виджетов пропустить от начала выборки. По умолчанию — 0

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.form.sitebutton.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":[["formId","=",45]],"order":{"id":"ASC"},"pagination":{"limit":50,"offset":0}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.form.sitebutton.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":[["formId","=",45]],"order":{"id":"ASC"},"pagination":{"limit":50,"offset":0},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.form.sitebutton.list

import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type FormSiteButtonListResult = {
  items: Array<{
    formId: number
    id: number
    name: string
    system: boolean
    bound: boolean
    formsId: number[]
    previewUrl: string
  }>
}

try {
  const response = await $b24.actions.v3.call.make<FormSiteButtonListResult>({
    method: 'crm.form.sitebutton.list',
    params: {
      filter: [['formId', '=', 45]],
      order: { id: 'ASC' },
      pagination: { limit: 50, offset: 0 },
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    result.items.forEach(item => console.info(item.id, item.name, item.bound))
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getFormSiteButtons() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'crm.form.sitebutton.list',
        params: {
          filter: [['formId', '=', 45]],
          order: { id: 'ASC' },
          pagination: { limit: 50, offset: 0 },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      result.items.forEach(item => console.info(item.id, item.name, item.bound))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getFormSiteButtons)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.form.sitebutton.list(
        filter=[["formId", "=", 45]],
        order={"id": "ASC"},
        pagination={"limit": 50, "offset": 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}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'crm.form.sitebutton.list',
            [
                'filter' => [['formId', '=', 45]],
                'order' => ['id' => 'ASC'],
                'pagination' => ['limit' => 50, 'offset' => 0],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'crm.form.sitebutton.list',
    {
        filter: [['formId', '=', 45]],
        order: { id: 'ASC' },
        pagination: { limit: 50, offset: 0 },
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'crm.form.sitebutton.list',
    [
        'filter' => [['formId', '=', 45]],
        'order' => ['id' => 'ASC'],
        'pagination' => ['limit' => 50, 'offset' => 0],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

res, err := client.Core().Call(ctx, "crm.form.sitebutton.list", b24.Params{
	"filter":     [][]any{{"formId", "=", 45}},
	"order":      map[string]string{"id": "ASC"},
	"pagination": map[string]int{"limit": 50, "offset": 0},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.form.sitebutton.list: %w", err)
}

raw, ok := b24.Unwrap(res.Result, "items")
if !ok {
	return fmt.Errorf("в ответе нет ключа items")
}

var items []struct {
	FormID     int    `json:"formId"`
	ID         int    `json:"id"`
	Name       string `json:"name"`
	System     bool   `json:"system"`
	Bound      bool   `json:"bound"`
	FormsID    []int  `json:"formsId"`
	PreviewURL string `json:"previewUrl"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, item := range items {
	fmt.Println(item.ID, item.Name, item.Bound)
}

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "formId": 45,
                "id": 1,
                "name": "Открытая линия, CRM-форма",
                "system": true,
                "bound": false,
                "formsId": [3],
                "previewUrl": "https://test.bitrix24.ru/pub/form/45/6el0zj/?view=preview&preview=button&preview_id=1"
            },
            {
                "formId": 45,
                "id": 3,
                "name": "Wix",
                "system": false,
                "bound": false,
                "formsId": [1],
                "previewUrl": "https://test.bitrix24.ru/pub/form/45/6el0zj/?view=preview&preview=button&preview_id=3"
            }
        ]
    },
    "time": {
        "start": 1792593647,
        "finish": 1792593647.396397,
        "duration": 0.39639711380004883,
        "processing": 0,
        "date_start": "2026-10-21T17:40:47+03:00",
        "date_finish": "2026-10-21T17:40:47+03:00",
        "operating_reset_at": 1792594200,
        "operating": 0.15324115753173828
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Объект с данными ответа

items
array

Список виджетов на сайт, подробное описание

time
time

Информация о времени выполнения запроса

Элемент массива items

Название
тип

Описание

formId
integer

Идентификатор CRM-формы из фильтра запроса

id
integer

Идентификатор виджета

name
string

Название виджета

system
boolean

Признак системного виджета.

Возможные значения:

  • true — виджет создан Битрикс24 автоматически
  • false — виджет создан пользователем

bound
boolean

Подключена ли форма из фильтра к этому виджету.

Возможные значения:

  • true — форма есть в активном слоте виджета
  • false — форма к виджету не подключена

formsId
integer[]

Идентификаторы всех CRM-форм, подключенных к виджету

previewUrl
string

Ссылка на предпросмотр виджета. Форма из фильтра видна в предпросмотре, только если bound равно true

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Значение поля не может быть пустым",
                "field": "filter"
            }
        ]
    }
}

Название
тип

Описание

error.code
string

Строковый код ошибки. Используйте для идентификации типа исключения

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибки фильтра и параметров запроса

HTTP-статус: 400

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

filter

Значение поля не может быть пустым

Передайте filter с условием [["formId", "=", <id формы>]]

id

В DTO SiteButtonDto в поле id требуется наличие атрибута Filterable для такого запроса

Фильтруйте только по formId

name

В DTO SiteButtonDto в поле name требуется наличие атрибута Sortable для такого запроса

Сортируйте только по id

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

filter.formId

Требуется указать фильтр по обязательному полю formId

Передайте условие по formId с оператором =

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Поле

Описание ошибки

Как исправить

filter

Не удается распознать выражение фильтра [["formId","=",0]]

Передайте одно условие [["formId", "=", <id формы>]] с положительным идентификатором, без логики or и отрицания

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDORDEREXCEPTION

Поле

Описание ошибки

Как исправить

order

Не удается распознать выражение сортировки UP

Передайте order в виде {"id": "ASC"} или {"id": "DESC"}

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION

Поле

Описание ошибки

Как исправить

pagination

Не удается распознать параметр пагинации {"limit":1001}

Передайте limit от 1 до 1000 и offset не меньше 0

Форма не найдена

HTTP-статус: 404

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле

Описание ошибки

Как исправить

formId

Запись с ID = 999999 не найдена

Проверьте идентификатор формы методом crm.form.list

Ошибки доступа

HTTP-статус: 403

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле

Описание ошибки

Как исправить

-

Доступ запрещен

Проверьте, что у пользователя есть право на просмотр CRM-форм

Код ошибки: BITRIX_CRM_V2_INFRASTRUCTURE_REST_EXCEPTION_FORM_SITEBUTTONACCESSDENIEDEXCEPTION

Поле

Описание ошибки

Как исправить

-

Недостаточно прав для просмотра виджетов на сайт

Выдайте пользователю право на просмотр виджетов на сайт в настройках прав CRM

Код ошибки: BITRIX_CRM_V2_INFRASTRUCTURE_REST_EXCEPTION_FORM_PHONEVERIFICATIONREQUIREDEXCEPTION

Поле

Описание ошибки

Как исправить

-

Чтобы добавить CRM-форму, подтвердите номер телефона

Подтвердите номер телефона в Битрикс24 и повторите запрос

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить поле вариантов размещения
Следующая
Получить список полей виджета на сайт