Get form list

Description

The method returns a list of forms with the ability to filter by tags, groups, publication status, and NPS type.

URL

Method: POST

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

Request Parameters

Parameter	Type	Example	Required	Description
token	string	a1b2c3d4e5f67890abcdef1234567890	Yes	API token
from_id	int	1	No	ID of the first form in the response
limit	int	50	No	Limit on the number of returned data
ui_tags	array[string]	["main", "feedback"]	No	List of tags to search
groups	array[string]	["clients", "partners"]	No	List of groups to search
groups_id	array[int]	[5, 12]	No	List of group IDs to search
is_nps	boolean	true	No	Filter by NPS forms
is_published	boolean	true	No	Filter by published forms

Request Example

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>

Response Example

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": "Customer Survey",
      "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>Customer Survey</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>

Response Parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
total_count	int	Total number of forms
data	array[object]	Array of form objects

data Array

Parameter	Type	Description
id	int	System form ID
group_id	int	Group ID
groups_id	array[int]	List of group IDs
is_delete	boolean	Deletion flag
createtime	string (date-time)	Creation date and time
updatetime	string (date-time)	Update date and time
name	string	Form name
shortname	string	Form short name
descr	string	Form description
type	string	Form type
ui_tags	array[string]	List of UI tags
is_nps	boolean	NPS form flag
is_published	boolean	Publication status
is_temporary	boolean	Temporary form flag
total_report	object	Form report
updated_user	object	User who updated the form

total_report Object

Parameter	Type	Description
is_form_fill	boolean	Whether form has fills
uloads	int	Number of unique loads
loads	int	Total number of loads
uposts	int	Number of unique submissions
posts	int	Total number of submissions
avg_fill_time_sec	int	Average fill time (in seconds)

updated_user Object

Parameter	Type	Description
name	string	Username
fname	string	First name
lname	string	Last name
avatar_date_update	string	Avatar update date