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

Описание

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

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"a1b2c3d4e5f67890abcdef1234567890"	Да	API-токен
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

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

XML

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

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

JSON

{
  "data": [
    {
      "id": 1,
      "group_id": 0,
      "groups_id": [],
      "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,
      "total_report": {
        "is_form_fill": false,
        "uloads": 0,
        "loads": 0,
        "uposts": 0,
        "posts": 0,
        "avg_fill_time_sec": 0
      },
      "updated_user": {
        "name": "userguide",
        "fname": "John",
        "lname": "Doe",
        "avatar_date_update": ""
      }
    }
  ],
  "error": 0,
  "error_text": "Successful operation",
  "total_count": 1
}

XML

<xml>
  <data>
    <id>1</id>
    <group_id>0</group_id>
    <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>
    <total_report>
      <is_form_fill>false</is_form_fill>
      <uloads>0</uloads>
      <loads>0</loads>
      <uposts>0</uposts>
      <posts>0</posts>
      <avg_fill_time_sec>0</avg_fill_time_sec>
    </total_report>
    <updated_user>
      <name>userguide</name>
      <fname>John</fname>
      <lname>Doe</lname>
      <avatar_date_update></avatar_date_update>
    </updated_user>
  </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	Системный идентификатор формы
group_id	int	Идентификатор группы
groups_id	array	Список идентификаторов групп
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	Признак временной формы
total_report	object	Отчет по форме
updated_user	object	Пользователь, обновивший форму

Объект total_report

Параметр	Тип	Описание
is_form_fill	boolean	Есть ли заполнения формы
uloads	int	Количество уникальных загрузок
loads	int	Общее количество загрузок
uposts	int	Количество уникальных отправок
posts	int	Общее количество отправок
avg_fill_time_sec	int	Среднее время заполнения (в секундах)

Объект updated_user

Параметр	Тип	Описание
name	string	Логин пользователя
fname	string	Имя
lname	string	Фамилия
avatar_date_update	string	Дата обновления аватара