Получение списка форм

Описание

Возвращает список форм с возможностью фильтрации по тегам, группам, статусу публикации и типу NPS.

URL-адрес

Метод: POST

https://example.com/api/v1.1/forms/list

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
from_id	int	1	Нет	Идентификатор первой формы в ответе
limit	int	50	Нет	Лимит на количество возвращаемых данных
ui_tags	array	["main", "feedback"]	Нет	Список тегов для поиска
groups	array	["clients", "partners"]	Нет	Список групп для поиска
groups_id	array	[5, 12]	Нет	Список ID групп для поиска
is_nps	boolean	true	Нет	Фильтр по NPS-формам
is_published	boolean	true	Нет	Фильтр по опубликованным формам

Пример запроса

JSON

{
    "id": 1,
    "limit": 1,
    "is_nps": true
}

XML

<xml>
  <id>1</id>
  <limit>2</limit>
  <is_nps>true</is_nps>
</xml>

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

JSON

{
  "data": [
    {
      "id": 1,
      "groups": [
        {"id": 2, "name": "example_group_1"},
        {"id": 3, "name": "example_group_2"}
      ],
      "is_delete": false,
      "createtime": "2026-02-20T10:43:51.91Z",
      "updatetime": "2026-03-26T13:19:23.961Z",
      "name": "Опрос клиентов",
      "shortname": "form_6Ven2v7O",
      "descr": "",
      "type": "basic",
      "ui_tags": [],
      "is_nps": false,
      "is_published": false,
      "is_temporary": false
    }
  ],
  "error": 0,
  "error_text": "Successful operation",
  "total_count": 1
}

XML

<xml>
  <data>
    <id>1</id>
    <groups>
      <id>2</id>
      <name>example_group_1</name>
    </groups>
    <groups>
      <id>3</id>
      <name>example_group_2</name>
    </groups>
    <is_delete>false</is_delete>
    <createtime>2026-02-20T10:43:51.91Z</createtime>
    <updatetime>2026-03-26T13:19:23.961Z</updatetime>
    <name>Опрос клиентов</name>
    <shortname>form_6Ven2v7O</shortname>
    <descr></descr>
    <type>basic</type>
    <is_nps>false</is_nps>
    <is_published>false</is_published>
    <is_temporary>false</is_temporary>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <total_count>1</total_count>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
total_count	int	Общее количество форм
data	array	Массив объектов форм

Массив data

Параметр	Тип	Описание
id	int	Системный идентификатор формы
groups	array[object]	Список групп. Каждый элемент — объект с полями id (int) и name (string)
is_delete	boolean	Флаг удаления
createtime	string	Дата и время создания
updatetime	string	Дата и время обновления
name	string	Название формы
shortname	string	Короткое имя формы
descr	string	Описание формы
type	string	Тип формы
ui_tags	array	Список UI-тегов
is_nps	boolean	Признак NPS-формы
is_published	boolean	Статус публикации
is_temporary	boolean	Признак временной формы