Export form fill data

Description

Exports form fill data to a file. To retrieve the result, you need to make three requests: create an export task, check the task status, and download the file.

Step 1. Creating an export task

Request URL

Method: POST

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

Request Parameters

Parameter	Type	Example	Required	Description
id	int	1	Yes, if shortname is not specified	Form ID
shortname	string	"form_6Ven2v7O"	Yes, if id is not specified	Form short name
date_from	string	"2026-04-01"	Yes	Start date of the period. Format: YYYY-MM-DD
date_to	string	"2026-04-30"	Yes	End date of the period. Format: YYYY-MM-DD

Request Example

JSON

{
  "id": 1,
  "date_from": "2026-04-01",
  "date_to": "2026-04-30"
}

XML

<xml>
  <id>1</id>
  <date_from>2026-04-01</date_from>
  <date_to>2026-04-30</date_to>
</xml>

Response Example

JSON

{
  "data": {
    "task_id": "550e8400-e29b-41d4-a716-446655440000"
  },
  "error": 0,
  "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <task_id>550e8400-e29b-41d4-a716-446655440000</task_id>
  </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	Response data object

data Object

Parameter	Type	Description
task_id	string	Async task ID for retrieving fill data

Step 2. Checking task status and getting download link

Request URL

Method: POST

https://example.com/api/v1.1/tasks/status

Request Parameters

Parameter	Type	Example	Required	Description
task_id	string	"550e8400-e29b-41d4-a716-446655440000"	Yes	Task ID from step 1

Request Example

JSON

{
  "task_id": "550e8400-e29b-41d4-a716-446655440000"
}

XML

<xml>
  <task_id>550e8400-e29b-41d4-a716-446655440000</task_id>
</xml>

Response Example

JSON

{
  "data": {
    "status": "completed",
    "progress": 100,
    "result": {
      "form_id": 1,
      "total": 42,
      "url": "abCDefghIklMnop57498257/1_20002_form_export.zip"
    }
  },
  "error": 0,
  "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <status>completed</status>
    <progress>100</progress>
    <result>
      <form_id>1</form_id>
      <total>42</total>
      <url>abCDefghIklMnop57498257/1_20002_form_export.zip</url>
    </result>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Response Parameters

Parameter	Type	Description
status	string	Task status (completed — task is done)
progress	int	Task progress in percent
result	object	Export result object. See result
error	int	Error code
error_text	string	Error text

result Object

Parameter	Type	Description
form_id	int	Form ID
total	int	Total number of fill records
url	string	Encrypted path to the data file

Step 3. Downloading the file

To download the file, send a GET request to a URL composed of the platform's base URL, the entity prefix, and the url value from the step 2 response:

https://example.com/api/download/forms/ + value of url

For example:

https://example.com/api/download/forms/abCDefghIklMnop57498257/1_20002_form_export.zip

where:

• https://example.com - link to the platform control panel
• api/download/forms/ - fixed prefix for form data export
• abCDefghIklMnop57498257/1_20002_form_export.zip - value of the url parameter from the step 2 response (encrypted path and file name)

The request must include the authorization header Authorization: Bearer <token>.