Получить информацию о форме
Описание
Позволяет узнать информацию о форме: с труктуру полей, настройки страниц, логику переходов, оформление и настроенные действия.
URL-адрес
Метод: POST
https://example.com/api/v1.1/forms/get
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| id | int | 1 | Да, если не указан shortname | Идентификатор формы. |
| shortname | string | "form_6Ven2v7O" | Да, если не указан id | Короткое имя формы. |
| form | boolean | true | Нет | Выгружать информацию о структуре формы. По умолчанию — false. |
| actions | boolean | true | Нет | Выгружать информацию о настроенных действиях. По умолчанию — false. |
Пример запроса
- JSON
- XML
{
"id": 1,
"form": true,
"actions": true
}
<xml>
<id>1</id>
<form>true</form>
<actions>true</actions>
</xml>
Пример ответа
- JSON
- XML
{
"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-04-23T11:00:46.242Z",
"name": "Пример формы",
"shortname": "form_6Ven2v7O",
"descr": "",
"type": "basic",
"ui_tags": [],
"is_nps": false,
"is_published": true,
"published_time": "2026-04-23T11:00:46.234Z",
"is_temporary": false,
"tz": "",
"actions": [
{
"action_id": "NrqKjgfX",
"type": "profile_import",
"profile_import": {
"db_id": 3,
"matching_mode": "email",
"mode_add": true,
"mode_update": true,
"is_update_utm": true,
"match_mapping": [
{
"ext_name": "field_4",
"ext_num": 0,
"int_name": "email",
"ignore_empty": true,
"are_nulls_empty": false,
"normalizers": [],
"action": "set",
"submatch": ""
}
],
"column_mapping": [
{
"ext_name": "field_1",
"ext_num": 0,
"int_name": "_fname",
"ignore_empty": false,
"are_nulls_empty": false,
"normalizers": [],
"action": "set",
"submatch": ""
},
{
"ext_name": "field_4",
"ext_num": 0,
"int_name": "phones",
"ignore_empty": false,
"are_nulls_empty": false,
"normalizers": [],
"action": "set",
"submatch": ""
}
],
"auto_subscribe": []
}
}
],
"form": {
"form_title": "Пример формы",
"last_page_id": 2,
"language": "RU",
"basic_form_pages": [
{
"id": 1,
"title": "Страница 1",
"shortname": "page_1",
"fields": [
{
"type": "line",
"name": "field_1",
"comment": "",
"hidden": false,
"title": "Имя",
"index_custom_option": -1,
"condition": {
"condition": "",
"value": null
},
"count_range": 5,
"min_range": 0,
"max_range": 20,
"options": [],
"default_value": "",
"validation_rules": [],
"right_answer": "",
"right_answer_score": 0,
"nps_field": null
},
{
"type": "email",
"name": "field_4",
"comment": "",
"hidden": false,
"title": "Email",
"index_custom_option": -1,
"condition": {
"condition": "",
"value": null
},
"count_range": 5,
"min_range": 0,
"max_range": 20,
"options": [],
"default_value": "",
"validation_rules": [
{
"type": "email",
"message": ""
}
],
"right_answer": "",
"right_answer_score": 0,
"nps_field": null
},
{
"type": "rating_stars",
"name": "field_5",
"comment": "",
"hidden": false,
"title": "Оценка",
"index_custom_option": -1,
"condition": {
"condition": "",
"value": null
},
"count_range": 5,
"min_range": 0,
"max_range": 20,
"options": [],
"default_value": 0,
"validation_rules": [],
"right_answer": "",
"right_answer_score": 0,
"nps_field": null
}
]
},
{
"id": 2,
"title": "Страница 2",
"shortname": "page_2",
"fields": [
{
"type": "line",
"name": "field_6",
"comment": "",
"hidden": false,
"title": "Дополнительный вопрос",
"index_custom_option": -1,
"condition": {
"condition": "",
"value": null
},
"count_range": 5,
"min_range": 0,
"max_range": 20,
"options": [],
"default_value": "",
"validation_rules": [],
"right_answer": "",
"right_answer_score": 0,
"nps_field": null
},
{
"type": "checkbox",
"name": "field_8",
"comment": "",
"hidden": false,
"title": "Чекбокс",
"index_custom_option": -1,
"condition": {
"condition": "",
"value": null
},
"count_range": 5,
"min_range": 0,
"max_range": 20,
"options": [],
"default_value": "",
"validation_rules": [],
"right_answer": "",
"right_answer_score": 0,
"nps_field": null
}
]
}
],
"final_page": {
"title": "Спасибо!",
"message": "Ваша форма успешно отправлена.",
"display_score": false,
"required_score": 0,
"redirect_pass_url": "",
"redirect_fail_url": ""
},
"style": {
"preset": "default",
"background_color": "#6590e7",
"background_image": "",
"buttons_color": "#000000",
"buttons_background_color": "#3678E2",
"font": "Fira Sans",
"text_align": "initial",
"font_color": "#0D0F12",
"font_size": 18,
"border_radius": 12,
"rating_stars_color": "#ffea78",
"rating_stars_background_color": "#f1f3f9",
"rate_star": {
"figure_selected_color": "",
"figure_unselected_color": "",
"figure_size": 0
},
"rate_heart": {
"figure_selected_color": "",
"figure_unselected_color": "",
"figure_size": 0
},
"rate_emoji": {
"figure_selected_color": "",
"figure_unselected_color": "",
"figure_size": 0
},
"rate_number": {
"buttons_selected_color": "",
"buttons_unselected_color": "",
"buttons_selected_background_color": "",
"buttons_unselected_background_color": "",
"number_size": 0
}
},
"next_button": {
"type": "next",
"size": 14,
"icon": "",
"title": "Следующая страница"
},
"prev_button": {
"type": "prev",
"size": 14,
"icon": "",
"title": "Предыдущая страница"
},
"send_button": {
"type": "send",
"size": 14,
"icon": "paper plane",
"title": "Send"
},
"final_button": {
"type": "final",
"size": 14,
"icon": "",
"title": "Go to the website"
},
"time_limit_sec": 900,
"form_check_sum": "f742b0a68fb3fa17c3d845487ed4b5ed3f6405b7",
"logic": [
{
"id": 1,
"title": "",
"page_id": 1,
"next_node": 2,
"type": "page",
"condition": []
},
{
"id": 2,
"title": "",
"page_id": 2,
"type": "page",
"condition": []
}
],
"start_logic_block_id": 1,
"last_form_logic_block_id": 2,
"is_logic_enabled": true,
"flowchart_elements": [
{
"data": {
"idOfLogicBlock": 1,
"idOfPage": 1,
"isFirstPage": true,
"label": "Страница 1"
},
"id": "jANe4JVI",
"position": {
"x": 18,
"y": 54
},
"type": "page"
},
{
"data": {
"idOfLogicBlock": 2,
"idOfPage": 2,
"isFirstPage": false,
"label": "Страница 2"
},
"id": "sBFQLU8K",
"position": {
"x": 26,
"y": 184
},
"type": "page"
},
{
"id": "EmaWmrar",
"source": "jANe4JVI",
"sourceHandle": null,
"target": "sBFQLU8K",
"targetHandle": null,
"type": "edge"
}
],
"is_nps": false,
"restrict_refill": true,
"resubmit_page": {
"title": "Ограничение!",
"message": "Вы уже заполняли эту форму.",
"display_score": false,
"required_score": 0,
"redirect_pass_url": "",
"redirect_fail_url": ""
},
"expired_days": 1
}
},
"error": 0,
"error_text": "Successful operation"
}
<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-04-23T11:00:46.242Z</updatetime>
<name>Пример формы</name>
<shortname>form_6Ven2v7O</shortname>
<descr/>
<type>basic</type>
<ui_tags/>
<is_nps>false</is_nps>
<is_published>true</is_published>
<published_time>2026-04-23T11:00:46.234Z</published_time>
<is_temporary>false</is_temporary>
<actions>
<action_id>NrqKjgfX</action_id>
<type>profile_import</type>
<profile_import>
<db_id>3</db_id>
<matching_mode>email</matching_mode>
<mode_add>true</mode_add>
<mode_update>true</mode_update>
<is_update_utm>true</is_update_utm>
<match_mapping>
<ext_name>field_4</ext_name>
<ext_num>0</ext_num>
<int_name>email</int_name>
<ignore_empty>true</ignore_empty>
<are_nulls_empty>false</are_nulls_empty>
<normalizers/>
<action>set</action>
<submatch/>
</match_mapping>
<column_mapping>
<ext_name>field_1</ext_name>
<ext_num>0</ext_num>
<int_name>_fname</int_name>
<ignore_empty>false</ignore_empty>
<are_nulls_empty>false</are_nulls_empty>
<normalizers/>
<action>set</action>
<submatch/>
</column_mapping>
<column_mapping>
<ext_name>field_4</ext_name>
<ext_num>0</ext_num>
<int_name>phones</int_name>
<ignore_empty>false</ignore_empty>
<are_nulls_empty>false</are_nulls_empty>
<normalizers/>
<action>set</action>
<submatch/>
</column_mapping>
<auto_subscribe/>
</profile_import>
</actions>
<form>
<form_title>Пример формы</form_title>
<last_page_id>2</last_page_id>
<language>RU</language>
<basic_form_pages>
<id>1</id>
<title>Страница 1</title>
<shortname>page_1</shortname>
<fields>
<type>line</type>
<name>field_1</name>
<comment/>
<hidden>false</hidden>
<title>Имя</title>
<index_custom_option>-1</index_custom_option>
<condition>
<condition/>
<value/>
</condition>
<count_range>5</count_range>
<min_range>0</min_range>
<max_range>20</max_range>
<options/>
<default_value/>
<validation_rules/>
<right_answer/>
<right_answer_score>0</right_answer_score>
<nps_field/>
</fields>
<fields>
<type>email</type>
<name>field_4</name>
<comment/>
<hidden>false</hidden>
<title>Email</title>
<index_custom_option>-1</index_custom_option>
<condition>
<condition/>
<value/>
</condition>
<count_range>5</count_range>
<min_range>0</min_range>
<max_range>20</max_range>
<options/>
<default_value/>
<validation_rules>
<type>email</type>
<message/>
</validation_rules>
<right_answer/>
<right_answer_score>0</right_answer_score>
<nps_field/>
</fields>
<fields>
<type>rating_stars</type>
<name>field_5</name>
<comment/>
<hidden>false</hidden>
<title>Оценка</title>
<index_custom_option>-1</index_custom_option>
<condition>
<condition/>
<value/>
</condition>
<count_range>5</count_range>
<min_range>0</min_range>
<max_range>20</max_range>
<options/>
<default_value>0</default_value>
<validation_rules/>
<right_answer/>
<right_answer_score>0</right_answer_score>
<nps_field/>
</fields>
</basic_form_pages>
<basic_form_pages>
<id>2</id>
<title>Страница 2</title>
<shortname>page_2</shortname>
<fields>
<type>line</type>
<name>field_6</name>
<comment/>
<hidden>false</hidden>
<title>Дополнительный вопрос</title>
<index_custom_option>-1</index_custom_option>
<condition>
<condition/>
<value/>
</condition>
<count_range>5</count_range>
<min_range>0</min_range>
<max_range>20</max_range>
<options/>
<default_value/>
<validation_rules/>
<right_answer/>
<right_answer_score>0</right_answer_score>
<nps_field/>
</fields>
<fields>
<type>checkbox</type>
<name>field_8</name>
<comment/>
<hidden>false</hidden>
<title>Чекбокс</title>
<index_custom_option>-1</index_custom_option>
<condition>
<condition/>
<value/>
</condition>
<count_range>5</count_range>
<min_range>0</min_range>
<max_range>20</max_range>
<options/>
<default_value/>
<validation_rules/>
<right_answer/>
<right_answer_score>0</right_answer_score>
<nps_field/>
</fields>
</basic_form_pages>
<final_page>
<title>Спасибо!</title>
<message>Ваша форма успешно отправлена.</message>
<display_score>false</display_score>
<required_score>0</required_score>
<redirect_pass_url/>
<redirect_fail_url/>
<final_redirect>false</final_redirect>
</final_page>
<style>
<preset>default</preset>
<background_color>#6590e7</background_color>
<background_image/>
<buttons_color>#000000</buttons_color>
<buttons_background_color>#3678E2</buttons_background_color>
<font>Fira Sans</font>
<text_align>initial</text_align>
<font_color>#0D0F12</font_color>
<font_size>18</font_size>
<border_radius>12</border_radius>
<rating_stars_color>#ffea78</rating_stars_color>
<rating_stars_background_color>#f1f3f9</rating_stars_background_color>
<rate_star>
<figure_selected_color/>
<figure_unselected_color/>
<figure_size>0</figure_size>
</rate_star>
<rate_heart>
<figure_selected_color/>
<figure_unselected_color/>
<figure_size>0</figure_size>
</rate_heart>
<rate_emoji>
<figure_selected_color/>
<figure_unselected_color/>
<figure_size>0</figure_size>
</rate_emoji>
<rate_number>
<buttons_selected_color/>
<buttons_unselected_color/>
<buttons_selected_background_color/>
<buttons_unselected_background_color/>
<number_size>0</number_size>
</rate_number>
</style>
<next_button>
<type>next</type>
<size>14</size>
<icon/>
<title>Следующая страница</title>
</next_button>
<prev_button>
<type>prev</type>
<size>14</size>
<icon/>
<title>Предыдущая страница</title>
</prev_button>
<send_button>
<type>send</type>
<size>14</size>
<icon>paper plane</icon>
<title>Send</title>
</send_button>
<final_button>
<type>final</type>
<size>14</size>
<icon/>
<title>Go to the website</title>
</final_button>
<time_limit_sec>900</time_limit_sec>
<form_check_sum>f742b0a68fb3fa17c3d845487ed4b5ed3f6405b7</form_check_sum>
<logic>
<id>1</id>
<title/>
<page_id>1</page_id>
<next_node>2</next_node>
<type>page</type>
<condition/>
</logic>
<logic>
<id>2</id>
<title/>
<page_id>2</page_id>
<type>page</type>
<condition/>
</logic>
<start_logic_block_id>1</start_logic_block_id>
<last_form_logic_block_id>2</last_form_logic_block_id>
<is_logic_enabled>true</is_logic_enabled>
<flowchart_elements>
<data>
<idOfLogicBlock>1</idOfLogicBlock>
<idOfPage>1</idOfPage>
<isFirstPage>true</isFirstPage>
<label>Страница 1</label>
</data>
<id>jANe4JVI</id>
<position>
<x>18</x>
<y>54</y>
</position>
<type>page</type>
</flowchart_elements>
<flowchart_elements>
<data>
<idOfLogicBlock>2</idOfLogicBlock>
<idOfPage>2</idOfPage>
<isFirstPage>false</isFirstPage>
<label> Страница 2</label>
</data>
<id>sBFQLU8K</id>
<position>
<x>26</x>
<y>184</y>
</position>
<type>page</type>
</flowchart_elements>
<flowchart_elements>
<id>EmaWmrar</id>
<source>jANe4JVI</source>
<sourceHandle>null</sourceHandle>
<target>sBFQLU8K</target>
<targetHandle>null</targetHandle>
<type>edge</type>
</flowchart_elements>
<is_nps>false</is_nps>
<restrict_refill>true</restrict_refill>
<resubmit_page>
<title>Ограничение!</title>
<message>Вы уже заполняли эту форму.</message>
<display_score>false</display_score>
<required_score>0</required_score>
<redirect_pass_url/>
<redirect_fail_url/>
</resubmit_page>
<expired_days>1</expired_days>
</form>
</data>
<error>0</error>
<error_text>Successful operation</error_text>
</xml>
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки. |
| error_text | string | Текст ошибки. |
| data | object | Информация о форме. см. data. |
Объект data
| Параметр | Тип | Описание |
|---|---|---|
| id | int | Системный идентификатор формы. |
| groups | array[object] | Список групп, к которым относится форма. Каждый элемент — объект с полями id (int) и name (string). |
| is_delete | boolean | Флаг удаления. |
| is_published | boolean | Флаг публикации. |
| name | string | Название формы. |
| descr | string | Описание формы. |
| createtime | string | Дата и время создания. |
| updatetime | string | Дата и время последнего обновления. |
| published_time | string | Дата и время публикации. |
| shortname | string | Внутренний идентификатор формы. |
| tz | string | Временная зона. |
| ui_tags | array[string] | Массив пользовательских меток. |
| is_nps | boolean | Флаг NPS-опроса. |
| actions | array | Массив действий (присутствует, если в запросе actions=true). Каждый элемент — объект action. |
| form | object | Объект с настройками формы (присутствует, если в запросе form=true). См. form. |
| type | string | Тип формы. Не используется, всегда "basic". |
| is_temporary | boolean | Неиспользуемый параметр (всегда false). |
Объект action (элемент массива actions)
| Параметр | Тип | Описание |
|---|---|---|
| action_id | string | Уникальный идентификатор действия. |
| type | string | Тип действия (например, "profile_import"). |
| profile_import | object | Объект с настройками импорта профиля. См. profile_import. |
Объект profile_import
| Параметр | Тип | Описание |
|---|---|---|
| db_id | int | Идентификатор базы данных. |
| matching_mode | string | Режим сопоставления (например, "email"). Подробнее о матчинге вы можете узнать в этой статьей. |
| mode_add | boolean | Разрешить добавление новых профилей. |
| mode_update | boolean | Разрешить обновление существующих профилей. |
| is_update_utm | boolean | Обновление UTM-меток. |
| skip_triggers | boolean | Пропуск триггеров. |
| use_geo | boolean | Использование геоданных. |
| auto_subscribe | array | Массив настроек автоподписки. |
| match_mapping | array | Массив для сопоставления записей. Каждый элемент — объект mapping. |
| column_mapping | array | Массив маппинга полей формы на поля базы. Каждый элемент — объект mapping. |
Объект mapping (элемент массивов match_mapping и column_mapping)
| Параметр | Тип | Описание |
|---|---|---|
| ext_name | string | Имя поля из формы. |
| int_name | string | Имя поля в целевой системе. |
| ignore_empty | boolean | Игнорировать пустые значения. |
| are_nulls_empty | boolean | Считать ли NULL пустым значением. |
| action | string | Действие (обычно "set"). |
| submatch | string | Подстанов очное выражение. Используется для кастомных полей в базе профилей с типом "Объект". |
| ext_num | int | Номер внешнего поля. Не используется, (по умочанию "0"). |
| normalizers | array | Массив нормализаторов. Не используется, всегда пустой массив. |
Объект form
| Параметр | Тип | Описание |
|---|---|---|
| form_title | string | Заголовок формы. |
| language | string | Код языка (например, "RU"). |
| is_nps | boolean | Флаг NPS-опроса (дублируется на верхнем уровне). |
| restrict_refill | boolean | Запрет повторного заполнения. |
| last_page_id | int | ID последней страницы. |
| basic_form_pages | array | Массив страниц формы. Каждая страница описана в page. |
| final_page | object | Финальная страница. См. final_page. |
| resubmit_page | object | Страница, показываемая при попытке повторного заполнения. См. resubmit_page. |
| style | object | Настройки стилей. См. style. |
| next_button | object | Кнопка "Далее". См. button. |
| prev_button | object | Кнопка "Назад". См. button. |
| send_button | object | Кнопка отправки. См. button. |
| final_button | object | Кнопка перехода на сайт. См. button. |
| time_limit_sec | int | Лимит времени заполнения в секундах. |
| form_check_sum | string | Контрольная сумма формы. |
| logic | array | Логика переходов между страницами. См. logic. |
| start_logic_block_id | int | ID начального блока логики. |
| last_form_logic_block_id | int | ID последнего блока логики. |
| is_logic_enabled | boolean | Включена ли логика переходов. |
| flowchart_elements | array | Элементы блок-схемы (для визуального редактора). |
| expired_days | int | Через сколько дней форма становится недоступной (1 – через день). |
| start_date | string | Дата и время начала активности формы (UTC). Если не задано — отсутствует. |
| end_date | string | Дата и время окончания активности формы (UTC). После этого форма перестаёт принимать ответы. |
Объект page (элемент массива basic_form_pages)
| Параметр | Тип | Описание |
|---|---|---|
| id | int | Идентификатор страницы. |
| title | string | Заголовок страницы. |
| shortname | string | Короткое имя страницы. |
| fields | array | Массив полей на странице. Каждое поле описано в field. |
Объект field (элемент массива fields)
| Параметр | Тип | Описание |
|---|---|---|
| type | string | Тип поля (line, email, rating_stars, checkbox и др.). |
| name | string | Системное имя поля. |
| title | string | Отображаемый заголовок поля. |
| comment | string | Комментарий к полю. |
| hidden | boolean | Скрытое поле. |
| default_value | string / number | Значение по умолчанию. |
| validation_rules | array | Правила валидации (например, {"type":"email","message":""}). |
| condition | object | Условие показа поля (обычно пустое). |
| options | array | Опции для выпадающих списков, радиокнопок и т.п. |
| right_answer | string | Правильный ответ (для тестов). |
| right_answer_score | number | Балл за правильный ответ. |
| nps_field | string/null | Связь с NPS-полем. |
Объект final_page
| Параметр | Тип | Описание |
|---|---|---|
| title | string | Заголовок финальной страницы. |
| message | string | Сообщение об успешной отправке. |
| display_score | boolean | Показывать ли набранные баллы. |
| required_score | int | Минимальный балл для прохождения. |
| redirect_pass_url | string | URL для редиректа при успехе. |
| redirect_fail_url | string | URL для редиректа при неудаче. |
Аналогичную структуру имеет resubmit_page (заголовок "Ограничение!", сообщение о повторном заполнении).
Объект button (для next_button, prev_button, send_button, final_button)
| Параметр | Тип | Описание |
|---|---|---|
| type | string | Тип кнопки (next, prev, send, final). |
| size | int | Размер шрифта (px). |
| icon | string | Имя иконки (например, "paper plane"). |
| title | string | Текст на кнопке. |
Объект style
| Параметр | Тип | Описание |
|---|---|---|
| preset | string | Имя предустановленного стиля ("default"). |
| background_color | string | Цвет фона (HEX). |
| background_image | string | URL фонового изображения. |
| font | string | Название шрифта. |
| font_color | string | Цвет шрифта. |
| font_size | int | Размер шрифта (px). |
| buttons_color | string | Цвет текста на кнопках. |
| buttons_background_color | string | Цвет фона кнопок. |
| border_radius | int | Скругление углов (px). |
| text_align | string | Выравнивание текста (initial, center и др.). |
| rating_stars_color | string | Цвет звёзд рейтинга. |
| rating_stars_background_color | string | Фон звёзд рейтинга. |
| rate_star, rate_heart, rate_emoji, rate_number | object | Дополнительные настройки для разных типов рейтинга. |
Объект logic (элемент массива logic)
| Параметр | Тип | Описание |
|---|---|---|
| id | int | Идентификатор блока логики. |
| title | string | Название (может быть пустым). |
| page_id | int | ID страницы, к которой относится блок. |
| next_node | int | ID следующего узла (только если есть переход). |
| next_node_true | int | ID следующего узла при выполнении условия (для типа condition). |
| next_node_false | int | ID следующего узла при невыполнении условия (для типа condition). |
| condition_type | string | Логический оператор для группы условий (and / or, для типа condition). |
| type | string | Тип блока (page или condition). |
| condition | array | Условия перехода. |
Подробнее о логике в формах вы можете узнать в статье Условная постраничная логика в формах и опросах