Check Export Status

curl --request GET \
  --url https://api.opnform.com/open/forms/{id}/submissions/export/status/{job_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.opnform.com/open/forms/{id}/submissions/export/status/{job_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.opnform.com/open/forms/{id}/submissions/export/status/{job_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.opnform.com/open/forms/{id}/submissions/export/status/{job_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.opnform.com/open/forms/{id}/submissions/export/status/{job_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.opnform.com/open/forms/{id}/submissions/export/status/{job_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "queued",
  "progress": 50,
  "job_id": "<string>",
  "processed_submissions": 123,
  "total_submissions": 123,
  "file_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

GET

open

forms

{id}

submissions

export

status

{job_id}

Check Export Status

curl --request GET \
  --url https://api.opnform.com/open/forms/{id}/submissions/export/status/{job_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.opnform.com/open/forms/{id}/submissions/export/status/{job_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.opnform.com/open/forms/{id}/submissions/export/status/{job_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.opnform.com/open/forms/{id}/submissions/export/status/{job_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.opnform.com/open/forms/{id}/submissions/export/status/{job_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.opnform.com/open/forms/{id}/submissions/export/status/{job_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "queued",
  "progress": 50,
  "job_id": "<string>",
  "processed_submissions": 123,
  "total_submissions": 123,
  "file_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Check Export Status

Check the status and progress of an asynchronous CSV export job.

Authentication & Scope

Requires forms-read ability.

Request

GET /open/forms/{id}/submissions/export/status/{job_id} HTTP/1.1
Host: api.opnform.com
Authorization: Bearer <token>

Path Parameters

Parameter	Type	Description
id	number	Numeric ID of the form.
job_id	string	Export job identifier.

Response

Processing Status

{
    "status": "processing",
    "progress": 65,
    "processed_submissions": 650,
    "total_submissions": 1000,
    "file_url": null,
    "error_message": null,
    "expires_at": null,
    "created_at": "2024-06-12T09:15:23.000Z",
    "updated_at": "2024-06-12T09:16:10.000Z",
    "job_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"
}

Completed Status

{
    "status": "completed",
    "progress": 100,
    "processed_submissions": 1000,
    "total_submissions": 1000,
    "file_url": "https://storage.example.com/exports/form-123-submissions-2024-06-12-09-15-23.csv",
    "error_message": null,
    "expires_at": "2024-06-13T09:15:23.000Z",
    "created_at": "2024-06-12T09:15:23.000Z",
    "updated_at": "2024-06-12T09:16:30.000Z",
    "job_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"
}

Failed Status

{
    "status": "failed",
    "progress": 0,
    "processed_submissions": null,
    "total_submissions": null,
    "file_url": null,
    "error_message": "Database connection timeout",
    "expires_at": null,
    "created_at": "2024-06-12T09:15:23.000Z",
    "updated_at": "2024-06-12T09:15:45.000Z",
    "job_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"
}

Response Fields

Field	Type	Description
`status`	string	Job status: `queued`, `processing`, `completed`, or `failed`
`progress`	number	Completion percentage (0-100)
`job_id`	string	Export job identifier
`processed_submissions`	number	Number of submissions processed so far
`total_submissions`	number	Total number of submissions to process
`file_url`	string	Download URL for completed exports
`expires_at`	string	File expiration timestamp (workspace policy, 24 hours by default)
`error_message`	string	Error description for failed exports
`created_at`	string	Job creation timestamp
`updated_at`	string	Last update timestamp

Every field is always present. Fields that do not apply to the current job state are null.

The download URL is a bearer link. It remains valid until expires_at, according to the workspace file-link policy (24 hours by default).

Error Responses

404 Not Found – Export job not found, has expired, or belongs to another form. 403 Forbidden – The token lacks forms-read or you don’t have access.

Usage Example

After initiating an export that returns is_async: true, poll this endpoint to track progress:

Start export

Call the export endpoint and receive a job_id.

Poll status

Use the job_id to check export progress every few seconds.

Avoid polling too frequently. Check every 2-5 seconds for optimal performance.

Download file

When status is completed, use the file_url to download your CSV file.

Download the file before the expires_at timestamp. The workspace policy is 24 hours by default.

Authorizations

Authorization

string

header

required

Personal Access Token

Path Parameters

number

required

job_id

string

required

Export job identifier

Response

Export job status

status

enum<string>

Current status of the export job

Available options:

queued,

processing,

completed,

failed

progress

number

Completion percentage (0-100)

Required range: 0 <= x <= 100

job_id

string

Export job identifier

processed_submissions

number | null

Number of submissions processed so far

total_submissions

number | null

Total number of submissions to process

file_url

string<uri> | null

Download URL for completed exports

expires_at

string<date-time> | null

File expiration timestamp (workspace policy, 24 hours by default)

error_message

string | null

Error description for failed exports

created_at

string<date-time>

Job creation timestamp

updated_at

string<date-time>

Last update timestamp

Overview

Workspaces

Forms

Submissions

Integrations

Workspace Users

Zapier

Check Export Status

Check Export Status

Authentication & Scope

Request

Path Parameters

Response

Processing Status

Completed Status

Failed Status

Response Fields

Error Responses

Usage Example

Authorizations

Path Parameters

Response

​Check Export Status

​Authentication & Scope

​Request

​Path Parameters

​Response

​Processing Status

​Completed Status

​Failed Status

​Response Fields

​Error Responses

​Usage Example

Authorizations

Path Parameters

Response

Check Export Status

Authentication & Scope

Request

Path Parameters

Response

Processing Status

Completed Status

Failed Status

Response Fields

Error Responses

Usage Example