Перейти к основному содержимому
Altcraft Docs LogoAltcraft Docs Logo
Пользователям iconПользователям
Разработчикам iconРазработчикам
Администраторам iconАдминистраторам
Русский
  • Русский
  • English
Войти
    API пользователяВзаимодействие с APIМатчинг
      Профилиarrow
    • Импортировать профильОбновить профильДобавить профиль в базу данныхПолучить информацию о профилеИмпортировать профиль в RabbitMQМассовое добавление профилей в базу данныхМассовое обновление профилейМассовый импорт профилейПриостановить все профили в базе данныхВосстановить все приостановленные профили в базе данныхУдалить профильУпрощенный импорт профиляФункциональное обновление полей базыФункциональное обновление полей подпискиВыгрузка профилей в файлПолучение данных по нескольким профилямОбъединение нескольких профилейОтписать профиль от ресурсаРазделение профиля
        Историяarrow
      • Получить историю одного профиляПолучить историю нескольких профилей
        Связи профилейarrow
      • Добавить связьУдалить связьУсилить/ослабить связьПерезаписать значения свойств связиПолучить информацию о связях профиляПолучить список связей профиля
        Подпискиarrow
      • Добавить или редактировать подпискуПолучить все подписки профиляПолучить все подписки нескольких профилейПолучить информацию о подписке профиляУдалить подписку профиляВосстановить удаленную подписку профиляПриостановить все подпискиВосстановить все приостановленные подписки
      Базы данныхarrow
    • Получить список баз данныхПолучить информацию о базе данныхПолучить информацию о полях базы данныхОчистка базы данных для тестированияПолучить статистику по базе данныхОбновить статистику по базе данных
      Ресурсыarrow
    • Получить список ресурсовПолучить информацию о ресурсеПолучить информацию о полях подписки ресурсаПолучить статистику по ресурсамОбновить статистику по ресурсам
      Сегментыarrow
    • Добавить сегментОбновить сегментПолучить информацию о сегментеПолучить список сегментовУдалить сегментПолучить статистику по сегментамОбновить статистику по сегментамДобавить или удалить профильПолучить данные профилей статического или обновляемого сегмента
      Стоп-спискиarrow
    • Добавить стоп-списокПереименовать стоп-списокПолучить информацию о стоп-спискеПолучить информацию о нескольких стоп-списковУдалить стоп-списокВыгрузить данные из стоп-списка в файл
        Добавление и удаление из стоп-спискаarrow
      • Проверить email-адрес в стоп-спискеДобавить email-адрес в стоп-списокДобавить один или несколько email-адресов в стоп-списокУдалить email-адрес из стоп-спискаУдалить все email-адреса из стоп-спискаПроверить домен в стоп-спискеДобавить домен в стоп-списокДобавить один или несколько доменов в стоп-списокУдалить домен из стоп-спискаУдалить все домены из стоп-спискаПроверить номер телефона в стоп-спискеДобавить номер телефона в стоп-списокДобавить один или несколько номеров в стоп-списокУдалить номер из стоп-спискаУдалить все номера из стоп-списка
      Шаблоныarrow
    • Получить список шаблоновПолучить информацию о шаблонеУдалить шаблонДобавить шаблон сообщенияОбновить шаблон сообщенияChannel object
      Рассылкиarrow
    • Получить список рассылокПолучить информацию о рассылкеПолучить лог рассылкиКлонировать рассылкуУдалить рассылкуАктивировать рассылкуДеактивировать рассылкуПолучить статус рассылки
        Броадкаст рассылкиarrow
      • Получить список броадкаст рассылокПолучить информацию о броадкаст рассылкеДобавить броадкаст рассылкуОбновить броадкаст рассылкуЗапустить броадкаст рассылку
        Регулярные рассылкиarrow
      • Получить список регулярных рассылокПолучить информацию о регулярной рассылкеДобавить регулярную рассылкуОбновить регулярную рассылкуЗапустить регулярную рассылку
        Триггерыarrow
      • Получить список триггерных рассылокПолучить информацию о триггерной рассылкеДобавить триггерную рассылкуОбновить триггерную рассылкуЗапуск триггерной рассылки (API call)Импорт профиля + Отправка триггераЗадание на массовую отправку триггераЗадание на массовый импорт профилей + отправка триггераМассовая отправка триггераМассовый импорт профилей + отправка триггераКлонировать триггер рассылкуData array
      Кампанииarrow
    • Получить информацию о кампанииПолучить список кампанийАктивация кампанииЗавершение кампанииДеактивация кампанииПолучить статус кампании
      Сценарии (цепочки)arrow
    • Отправить профиль клиента в сценарийОдновременный импорт и запуск профиля в сценарийМассовый импорт и запуск профилей в сценарийЗадание на массовый импорт и запуск профилей в сценарийПолучить список сценариевАктивировать сценарийДеактивировать сценарий
      Промокодыarrow
    • Импортировать промокодыПолучить информацию о промокодеАктивировать промокодОбновить промокодПривязать промокод к профилюОтвязать промокод от профиляПолучить все промокоды
      Программы лояльностиarrow
    • Получить уровень профиля в программе лояльностиЭкспорт транзакций балловСгораемые баллы за периодПолучение транзакций по счёту профиляПолучение списка триггерных промоакцийНачисление баллов участникуСписание баллов участникаПодтверждение временной транзакцииПредварительный расчет заказаПодтверждение заказаОтмена временной транзакцииОтмена балльной транзакцииПолучение баланса балльного счётаРегистрация участника в программе лояльностиМассовая регистрация участников в программу лояльностиЗадание на массовое добавление участников в программу лояльностиУдаление участника из программы лояльности
      Формыarrow
    • Получить информацию о формеПолучение списка формЭкспорт данных заполнений формыОпубликовать формуСнять форму с публикацииУдалить форму
      Целиarrow
    • Регистрация события достижения цели
      Пуши приложенийarrow
    • Обработка и добавление подпискиДобавить события с app push
      Маркетarrow
      • Объекты маркетаarrow
      • Структура заказа (order data object)Product data objectСтруктура SKU (SKU data object)Категории (categories array)Custom fields array
        Заказыarrow
      • Импорт заказа и статусов позицийПолучить список заказовУдалить заказПолучить статус заказаИзменение статуса позиции заказа
        Продукты и SKUarrow
      • Импорт продуктов, SKU и категорийПолучение списка продуктовПолучение списка SKUИмпорт SKU и категорийУдалить продуктыУдалить SKU
      Отчеты и статистикаarrow
    • Получить сводный отчетПолучить отчет о возвратахПолучить отчет о недоставках
      Сендерыarrow
    • Получить список сендеров
        Виртуальные сендерыarrow
      • Получить список виртуальных сендеровПолучить информацию о виртуальном сендереКлонировать виртуальный сендерДобавить виртуальный сендерОбновить виртуальный сендерУдалить виртуальный сендер
      Объектыarrow
    • AKMTA objectContent objectEmail rule objectFile objectProfile data objectSMS rule objectSender objectSender typesStart schedule objectSubscription objectTrigger types
      Запросы к внешним базам данныхarrow
      • Запросы сегментацииarrow
      • Добавить запрос сегментацииОбновить запрос сегментацииПолучить информацию о запросе сегментацииПолучить список запросов на сегментациюУдалить запрос сегментации
        Запросы для шаблоновarrow
      • Добавить запрос для шаблоновОбновить запрос для шаблоновПолучить информацию о запросе для шаблоновПолучить список запросов для шаблоновУдалить запрос для шаблонов
      Прочееarrow
    • Загрузить файлПолучить веб-версию сообщенияPush провайдерыДедупликация запросовРабота с API через RabbitMQСписок гендерных идентификацийПолучить допустимые значения полей browsers, devices, tz, oses, languages
    Список API-методовИмпорт и настройка коллекции API-методов в Postman
      SDKarrow
      • mSDKarrow
        • Androidarrow
        • Быстрый стартКонфигурация SDKФункционал SDKПубличный API SDK
            Настройка провайдеровarrow
          • Firebase Cloud MessagingHuawei Mobile ServicesRuStore
          iOSarrow
        • Быстрый стартКонфигурация SDKФункционал SDKПубличный API SDK
            Настройка провайдеровarrow
          • Apple Push Notification ServiceFirebase Cloud MessagingHuawei Mobile Services
          React Native (Android/iOS)arrow
        • Быстрый стартКонфигурация SDKФункционал SDKПубличный API SDKНастройка провайдеров
        Работа с ролевым и JWT-токеном
  • Формы
  • Получить информацию о форме

Получить информацию о форме

Описание​

Позволяет узнать информацию о форме: структуру полей, настройки страниц, логику переходов, оформление и настроенные действия.

URL-адрес​

Метод: POST

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

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

ПараметрТипПримерОбязательныйОписание
tokenstring"a1b2c3d4e5f67890abcdef1234567890"ДаAPI-токен.
idint1Да, если не указан shortnameИдентификатор формы.
shortnamestring"form_6Ven2v7O"Да, если не указан idКороткое имя формы.
formbooleantrueНетВыгружать информацию о структуре формы. По умолчанию — false.
actionsbooleantrueНетВыгружать информацию о настроенных действиях. По умолчанию — false.

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

  • JSON
  • XML
{
"token": "a1b2c3d4e5f67890abcdef1234567890",
"id": 1,
"form": true,
"actions": true
}
<xml>
<token>a1b2c3d4e5f67890abcdef1234567890</token>
<id>1</id>
<form>true</form>
<actions>true</actions>
</xml>

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

  • JSON
  • XML
{
"data": {
"id": 1,
"group_id": 0,
"groups_id": [],
"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,
"updated_user": {
"name": "account_john",
"fname": "John",
"lname": "Doe",
"avatar_date_update": ""
},
"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>
<group_id>0</group_id>
<groups_id/>
<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>
<updated_user>
<name>account_john</name>
<fname>John</fname>
<lname>Doe</lname>
<avatar_date_update/>
</updated_user>
<tz/>
<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>

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

ПараметрТипОписание
errorintКод ошибки.
error_textstringТекст ошибки.
dataobjectИнформация о форме. см. data.

Объект data​

ПараметрТипОписание
idintСистемный идентификатор формы.
group_idintИдентификатор группы.
groups_idarray[int]Список идентификаторов групп.
is_deletebooleanФлаг удаления.
is_publishedbooleanФлаг публикации.
namestringНазвание формы.
descrstringОписание формы.
createtimestringДата и время создания.
updatetimestringДата и время последнего обновления.
published_timestringДата и время публикации.
shortnamestringВнутренний идентификатор формы.
tzstringВременная зона.
ui_tagsarray[string]Массив пользовательских меток.
is_npsbooleanФлаг NPS-опроса.
updated_userobjectПользователь, последним обновивший форму. См. updated_user.
actionsarrayМассив действий (присутствует, если в запросе actions=true). Каждый элемент — объект action.
formobjectОбъект с настройками формы (присутствует, если в запросе form=true). См. form.
typestringТип формы. Не используется, всегда "basic".
is_temporarybooleanНеиспользуемый параметр (всегда false).

Объект updated_user​

ПараметрТипОписание
namestringНикнейм пользователя.
fnamestringИмя.
lnamestringФамилия.
avatar_date_updatestringДата последнего обновления аватара.
apistringВозвращает токен запроса, если форма была обновлена через API.

Объект action (элемент массива actions)​

ПараметрТипОписание
action_idstringУникальный идентификатор действия.
typestringТип действия (например, "profile_import").
profile_importobjectОбъект с настройками импорта профиля. См. profile_import.

Объект profile_import​

ПараметрТипОписание
db_idintИдентификатор базы данных.
matching_modestringРежим сопоставления (например, "email"). Подробнее о матчинге вы можете узнать в этой статьей.
mode_addbooleanРазрешить добавление новых профилей.
mode_updatebooleanРазрешить обновление существующих профилей.
is_update_utmbooleanОбновление UTM-меток.
skip_triggersbooleanПропуск триггеров.
use_geobooleanИспользование геоданных.
auto_subscribearrayМассив настроек автоподписки.
match_mappingarrayМассив для сопоставления записей. Каждый элемент — объект mapping.
column_mappingarrayМассив маппинга полей формы на поля базы. Каждый элемент — объект mapping.

Объект mapping (элемент массивов match_mapping и column_mapping)​

ПараметрТипОписание
ext_namestringИмя поля из формы.
int_namestringИмя поля в целевой системе.
ignore_emptybooleanИгнорировать пустые значения.
are_nulls_emptybooleanСчитать ли NULL пустым значением.
actionstringДействие (обычно "set").
submatchstringПодстановочное выражение. Используется для кастомных полей в базе профилей с типом "Объект".
ext_numintНомер внешнего поля. Не используется, (по умочанию "0").
normalizersarrayМассив нормализаторов. Не используется, всегда пустой массив.

Объект form​

ПараметрТипОписание
form_titlestringЗаголовок формы.
languagestringКод языка (например, "RU").
is_npsbooleanФлаг NPS-опроса (дублируется на верхнем уровне).
restrict_refillbooleanЗапрет повторного заполнения.
last_page_idintID последней страницы.
basic_form_pagesarrayМассив страниц формы. Каждая страница описана в page.
final_pageobjectФинальная страница. См. final_page.
resubmit_pageobjectСтраница, показываемая при попытке повторного заполнения. См. resubmit_page.
styleobjectНастройки стилей. См. style.
next_buttonobjectКнопка "Далее". См. button.
prev_buttonobjectКнопка "Назад". См. button.
send_buttonobjectКнопка отправки. См. button.
final_buttonobjectКнопка перехода на сайт. См. button.
time_limit_secintЛимит времени заполнения в секундах.
form_check_sumstringКонтрольная сумма формы.
logicarrayЛогика переходов между страницами. См. logic.
start_logic_block_idintID начального блока логики.
last_form_logic_block_idintID последнего блока логики.
is_logic_enabledbooleanВключена ли логика переходов.
flowchart_elementsarrayЭлементы блок-схемы (для визуального редактора).
expired_daysintЧерез сколько дней форма становится недоступной (1 – через день).
start_datestringДата и время начала активности формы (UTC). Если не задано — отсутствует.
end_datestringДата и время окончания активности формы (UTC). После этого форма перестаёт принимать ответы.

Объект page (элемент массива basic_form_pages)​

ПараметрТипОписание
idintИдентификатор страницы.
titlestringЗаголовок страницы.
shortnamestringКороткое имя страницы.
fieldsarrayМассив полей на странице. Каждое поле описано в field.

Объект field (элемент массива fields)​

ПараметрТипОписание
typestringТип поля (line, email, rating_stars, checkbox и др.).
namestringСистемное имя поля.
titlestringОтображаемый заголовок поля.
commentstringКомментарий к полю.
hiddenbooleanСкрытое поле.
default_valuestring / numberЗначение по умолчанию.
validation_rulesarrayПравила валидации (например, {"type":"email","message":""}).
conditionobjectУсловие показа поля (обычно пустое).
optionsarrayОпции для выпадающих списков, радиокнопок и т.п.
right_answerstringПравильный ответ (для тестов).
right_answer_scorenumberБалл за правильный ответ.
nps_fieldstring/nullСвязь с NPS-полем.

Объект final_page​

ПараметрТипОписание
titlestringЗаголовок финальной страницы.
messagestringСообщение об успешной отправке.
display_scorebooleanПоказывать ли набранные баллы.
required_scoreintМинимальный балл для прохождения.
redirect_pass_urlstringURL для редиректа при успехе.
redirect_fail_urlstringURL для редиректа при неудаче.

Аналогичную структуру имеет resubmit_page (заголовок "Ограничение!", сообщение о повторном заполнении).

Объект button (для next_button, prev_button, send_button, final_button)​

ПараметрТипОписание
typestringТип кнопки (next, prev, send, final).
sizeintРазмер шрифта (px).
iconstringИмя иконки (например, "paper plane").
titlestringТекст на кнопке.

Объект style​

ПараметрТипОписание
presetstringИмя предустановленного стиля ("default").
background_colorstringЦвет фона (HEX).
background_imagestringURL фонового изображения.
fontstringНазвание шрифта.
font_colorstringЦвет шрифта.
font_sizeintРазмер шрифта (px).
buttons_colorstringЦвет текста на кнопках.
buttons_background_colorstringЦвет фона кнопок.
border_radiusintСкругление углов (px).
text_alignstringВыравнивание текста (initial, center и др.).
rating_stars_colorstringЦвет звёзд рейтинга.
rating_stars_background_colorstringФон звёзд рейтинга.
rate_star, rate_heart, rate_emoji, rate_numberobjectДополнительные настройки для разных типов рейтинга.

Объект logic (элемент массива logic)​

ПараметрТипОписание
idintИдентификатор блока логики.
titlestringНазвание (может быть пустым).
page_idintID страницы, к которой относится блок.
next_nodeintID следующего узла (только если есть переход).
next_node_trueintID следующего узла при выполнении условия (для типа condition).
next_node_falseintID следующего узла при невыполнении условия (для типа condition).
condition_typestringЛогический оператор для группы условий (and / or, для типа condition).
typestringТип блока (page или condition).
conditionarrayУсловия перехода.

Подробнее о логике в формах вы можете узнать в статье Условная постраничная логика в формах и опросах

Последнее обновление 5 мая 2026 г.
Предыдущая страница
Формы
Следующая страница
Получение списка форм
  • Описание
  • URL-адрес
  • Параметры запроса
  • Пример запроса
  • Пример ответа
  • Возвращаемые параметры
    • Объект data
      • Объект updated_user
    • Объект action (элемент массива actions)
      • Объект profile_import
      • Объект mapping (элемент массивов match_mapping и column_mapping)
    • Объект form
      • Объект page (элемент массива basic_form_pages)
      • Объект field (элемент массива fields)
      • Объект final_page
      • Объект button (для next_button, prev_button, send_button, final_button)
      • Объект style
      • Объект logic (элемент массива logic)
© 2015 - 2026 Altcraft. Все права защищены.