Get form information
Description
Allows you to retrieve information about a form: field structure, page settings, transition logic, styling, and configured actions.
URL
Method: POST
https://example.com/api/v1.1/forms/get
Request Parameters
| Parameter | Type | Example | Required | Description |
|---|---|---|---|---|
| token | string | "a1b2c3d4e5f67890abcdef1234567890" | Yes | API token. |
| id | int | 1 | Yes, if shortname is not specified | Form ID. |
| shortname | string | "form_6Ven2v7O" | Yes, if id is not specified | Form short name. |
| form | boolean | true | No | Whether to export form structure info. Default — false. |
| actions | boolean | true | No | Whether to export configured actions info. Default — false. |
Request Example
- JSON
- XML
{
"token": "a1b2c3d4e5f67890abcdef1234567890",
"id": 1,
"form": true,
"actions": true
}
<xml>
<token>a1b2c3d4e5f67890abcdef1234567890</token>
<id>1</id>
<form>true</form>
<actions>true</actions>
</xml>
Response Example
- 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": "Example Form",
"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": "Example Form",
"last_page_id": 2,
"language": "EN",
"basic_form_pages": [
{
"id": 1,
"title": "Page 1",
"shortname": "page_1",
"fields": [
{
"type": "line",
"name": "field_1",
"comment": "",
"hidden": false,
"title": "Name",
"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": "Rating",
"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": "Page 2",
"shortname": "page_2",
"fields": [
{
"type": "line",
"name": "field_6",
"comment": "",
"hidden": false,
"title": "Additional Question",
"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": "Checkbox",
"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": "Thank you!",
"message": "Your form has been submitted successfully.",
"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": "Next Page"
},
"prev_button": {
"type": "prev",
"size": 14,
"icon": "",
"title": "Previous Page"
},
"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": "Page 1"
},
"id": "jANe4JVI",
"position": {
"x": 18,
"y": 54
},
"type": "page"
},
{
"data": {
"idOfLogicBlock": 2,
"idOfPage": 2,
"isFirstPage": false,
"label": "Page 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": "Restriction!",
"message": "You have already filled out this form.",
"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>Example Form</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>Example Form</form_title>
<last_page_id>2</last_page_id>
<language>EN</language>
<basic_form_pages>
<id>1</id>
<title>Page 1</title>
<shortname>page_1</shortname>
<fields>
<type>line</type>
<name>field_1</name>
<comment/>
<hidden>false</hidden>
<title>Name</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>Rating</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>Page 2</title>
<shortname>page_2</shortname>
<fields>
<type>line</type>
<name>field_6</name>
<comment/>
<hidden>false</hidden>
<title>Additional Question</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>Checkbox</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>Thank you!</title>
<message>Your form has been submitted successfully.</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>Next Page</title>
</next_button>
<prev_button>
<type>prev</type>
<size>14</size>
<icon/>
<title>Previous Page</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>Page 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>Page 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>Restriction!</title>
<message>You have already filled out this form.</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>
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| error | int | Error code. |
| error_text | string | Error text. |
| data | object | Form information. See data. |
data Object
| 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. |
| is_published | boolean | Publication flag. |
| name | string | Form name. |
| descr | string | Form description. |
| createtime | string | Creation date and time. |
| updatetime | string | Last update date and time. |
| published_time | string | Publication date and time. |
| shortname | string | Internal form ID. |
| tz | string | Time zone. |
| ui_tags | array[string] | Array of user tags. |
| is_nps | boolean | NPS survey flag. |
| updated_user | object | User who last updated the form. See updated_user. |
| actions | array | Array of actions (present if actions=true in request). Each element is an action object. |
| form | object | Form settings object (present if form=true in request). See form. |
| type | string | Form type. Not used, always "basic". |
| is_temporary | boolean | Unused parameter (always false). |
updated_user Object
| Parameter | Type | Description |
|---|---|---|
| name | string | Username. |
| fname | string | First name. |
| lname | string | Last name. |
| avatar_date_update | string | Last avatar update date. |
| api | string | Returns the request token if the form was updated via API. |
action Object (element of actions array)
| Parameter | Type | Description |
|---|---|---|
| action_id | string | Unique action ID. |
| type | string | Action type (e.g., "profile_import"). |
| profile_import | object | Profile import settings. See profile_import. |
profile_import Object
| Parameter | Type | Description |
|---|---|---|
| db_id | int | Database ID. |
| matching_mode | string | Matching mode (e.g., "email"). For more details about matching, see this article. |
| mode_add | boolean | Allow adding new profiles. |
| mode_update | boolean | Allow updating existing profiles. |
| is_update_utm | boolean | Update UTM tags. |
| skip_triggers | boolean | Skip triggers. |
| use_geo | boolean | Use geodata. |
| auto_subscribe | array | Auto-subscription settings array. |
| match_mapping | array | Record matching mapping array. Each element is a mapping object. |
| column_mapping | array | Form field to database field mapping array. Each element is a mapping object. |
mapping Object (element of match_mapping and column_mapping arrays)
| Parameter | Type | Description |
|---|---|---|
| ext_name | string | Form field name. |
| int_name | string | Field name in the target system. |
| ignore_empty | boolean | Ignore empty values. |
| are_nulls_empty | boolean | Whether to treat NULL as empty. |
| action | string | Action (usually "set"). |
| submatch | string | Substitution expression. Used for custom fields in the profile database of type "Object". |
| ext_num | int | External field number. Not used (default is "0"). |
| normalizers | array | Normalizers array. Not used, always an empty array. |
form Object
| Parameter | Type | Description |
|---|---|---|
| form_title | string | Form title. |
| language | string | Language code (e.g., "EN"). |
| is_nps | boolean | NPS survey flag (duplicated at the top level). |
| restrict_refill | boolean | Prevent repeat filling. |
| last_page_id | int | Last page ID. |
| basic_form_pages | array | Array of form pages. Each page is described in page. |
| final_page | object | Final page. See final_page. |
| resubmit_page | object | Page shown when attempting to refill. See resubmit_page. |
| style | object | Style settings. See style. |
| next_button | object | "Next" button. See button. |
| prev_button | object | "Previous" button. See button. |
| send_button | object | Submit button. See button. |
| final_button | object | "Go to website" button. See button. |
| time_limit_sec | int | Fill time limit in seconds. |
| form_check_sum | string | Form checksum. |
| logic | array | Page transition logic. See logic. |
| start_logic_block_id | int | Starting logic block ID. |
| last_form_logic_block_id | int | Last logic block ID. |
| is_logic_enabled | boolean | Whether transition logic is enabled. |
| flowchart_elements | array | Flowchart elements (for the visual editor). |
| expired_days | int | Days until the form becomes unavailable (1 — after one day). |
| start_date | string | Form activation start date and time (UTC). If not set — absent. |
| end_date | string | Form activation end date and time (UTC). After this, the form stops accepting responses. |
page Object (element of basic_form_pages array)
| Parameter | Type | Description |
|---|---|---|
| id | int | Page ID. |
| title | string | Page title. |
| shortname | string | Page short name. |
| fields | array | Array of fields on the page. Each field is described in field. |
field Object (element of fields array)
| Parameter | Type | Description |
|---|---|---|
| type | string | Field type (line, email, rating_stars, checkbox, etc.). |
| name | string | System field name. |
| title | string | Displayed field title. |
| comment | string | Field comment. |
| hidden | boolean | Hidden field. |
| default_value | string / number | Default value. |
| validation_rules | array | Validation rules (e.g., {"type":"email","message":""}). |
| condition | object | Field display condition (usually empty). |
| options | array | Options for dropdowns, radio buttons, etc. |
| right_answer | string | Correct answer (for quizzes). |
| right_answer_score | number | Score for correct answer. |
| nps_field | string/null | Link to NPS field. |
final_page Object
| Parameter | Type | Description |
|---|---|---|
| title | string | Final page title. |
| message | string | Successful submission message. |
| display_score | boolean | Whether to display the score. |
| required_score | int | Minimum score to pass. |
| redirect_pass_url | string | Redirect URL on success. |
| redirect_fail_url | string | Redirect URL on failure. |
resubmit_page has a similar structure (title "Restriction!", message about already filled).
button Object (for next_button, prev_button, send_button, final_button)
| Parameter | Type | Description |
|---|---|---|
| type | string | Button type (next, prev, send, final). |
| size | int | Font size (px). |
| icon | string | Icon name (e.g., "paper plane"). |
| title | string | Button text. |
style Object
| Parameter | Type | Description |
|---|---|---|
| preset | string | Preset style name ("default"). |
| background_color | string | Background color (HEX). |
| background_image | string | Background image URL. |
| font | string | Font name. |
| font_color | string | Font color. |
| font_size | int | Font size (px). |
| buttons_color | string | Button text color. |
| buttons_background_color | string | Button background color. |
| border_radius | int | Border radius (px). |
| text_align | string | Text alignment (initial, center, etc.). |
| rating_stars_color | string | Rating stars color. |
| rating_stars_background_color | string | Rating stars background color. |
| rate_star, rate_heart, rate_emoji, rate_number | object | Additional settings for different rating types. |
logic Object (element of logic array)
| Parameter | Type | Description |
|---|---|---|
| id | int | Logic block ID. |
| title | string | Title (may be empty). |
| page_id | int | ID of the page this block belongs to. |
| next_node | int | ID of the next node (only if there is a transition). |
| next_node_true | int | ID of the next node when condition is met (for type condition). |
| next_node_false | int | ID of the next node when condition is not met (for type condition). |
| condition_type | string | Logical operator for a group of conditions (and / or, for type condition). |
| type | string | Block type (page or condition). |
| condition | array | Transition conditions. |
For more details about form logic, see the article Conditional Page-by-Page Logic in Forms and Surveys