List Submissions
curl --request GET \
--url https://api.opnform.com/open/forms/{id}/submissions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.opnform.com/open/forms/{id}/submissions"
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', 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",
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"
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))
}HttpResponse<String> response = Unirest.get("https://api.opnform.com/open/forms/{id}/submissions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opnform.com/open/forms/{id}/submissions")
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{
"data": [
{
"id": 123,
"form_id": 123,
"completion_time": 123,
"data": {},
"meta": {
"attribution": {
"utm_source": "<string>",
"utm_medium": "<string>",
"utm_campaign": "<string>",
"utm_id": "<string>",
"utm_term": "<string>",
"utm_content": "<string>",
"utm_source_platform": "<string>",
"utm_creative_format": "<string>",
"utm_marketing_tactic": "<string>",
"gclid": "<string>",
"gbraid": "<string>",
"wbraid": "<string>",
"dclid": "<string>",
"fbclid": "<string>",
"ttclid": "<string>",
"msclkid": "<string>"
}
}
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 123,
"from": 123,
"last_page": 123,
"per_page": 123,
"to": 123,
"total": 123
}
}Submissions
List Submissions
Requires forms-read. Supports pagination, search, and status filtering.
GET
/
open
/
forms
/
{id}
/
submissions
List Submissions
curl --request GET \
--url https://api.opnform.com/open/forms/{id}/submissions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.opnform.com/open/forms/{id}/submissions"
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', 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",
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"
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))
}HttpResponse<String> response = Unirest.get("https://api.opnform.com/open/forms/{id}/submissions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opnform.com/open/forms/{id}/submissions")
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{
"data": [
{
"id": 123,
"form_id": 123,
"completion_time": 123,
"data": {},
"meta": {
"attribution": {
"utm_source": "<string>",
"utm_medium": "<string>",
"utm_campaign": "<string>",
"utm_id": "<string>",
"utm_term": "<string>",
"utm_content": "<string>",
"utm_source_platform": "<string>",
"utm_creative_format": "<string>",
"utm_marketing_tactic": "<string>",
"gclid": "<string>",
"gbraid": "<string>",
"wbraid": "<string>",
"dclid": "<string>",
"fbclid": "<string>",
"ttclid": "<string>",
"msclkid": "<string>"
}
}
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 123,
"from": 123,
"last_page": 123,
"per_page": 123,
"to": 123,
"total": 123
}
}List Submissions
Retrieve submissions for a specific form.Authentication & Scope
Requiresforms-read ability.
Request
GET /open/forms/{id}/submissions?page=1 HTTP/1.1
Host: api.opnform.com
Authorization: Bearer <token>
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| id | number | Numeric ID of the form. |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | No | Pagination page number (default 1). |
| per_page | number | No | Number of results per page (default 100, max 100). |
| search | string | No | Search term to filter submissions by field values. |
| status | string | No | Filter by submission status: completed, partial, or all (default). |
Response
200 OK – Returns a paginated collection of Submission objects.
{
"data": [
{
"data": {
"field-id-1": "Sample text response",
"field-id-2": ["Option 1", "Option 2"],
"field-id-3": [
{
"file_url": "https://api.opnform.com/open/forms/123/submissions/file/document.pdf?expires=1756808073&signature=abc123...",
"file_name": "document.pdf"
}
],
"status": "completed",
"created_at": "2024-06-12 09:15:23",
"id": 615432
},
"completion_time": 45,
"form_id": 123,
"id": 615432,
"meta": {
"attribution": {
"utm_source": "newsletter",
"utm_campaign": "summer-launch"
}
}
}
],
"links": {
"first": "https://api.opnform.com/open/forms/123/submissions?page=1",
"last": "https://api.opnform.com/open/forms/123/submissions?page=3",
"prev": null,
"next": "https://api.opnform.com/open/forms/123/submissions?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 3,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://api.opnform.com/open/forms/123/submissions?page=1",
"label": "1",
"active": true
},
{
"url": "https://api.opnform.com/open/forms/123/submissions?page=2",
"label": "Next »",
"active": false
}
],
"path": "https://api.opnform.com/open/forms/123/submissions",
"per_page": 100,
"to": 12,
"total": 12
}
}
Response Fields
Each submission object contains:| Field | Type | Description |
|---|---|---|
data | object | Contains form field responses plus metadata |
completion_time | number/null | Time taken to complete the form in seconds |
form_id | number | ID of the parent form |
id | number | Unique submission ID |
meta | object/null | Owner-only submission metadata, including campaign attribution when captured |
Data Object Structure
Thedata object contains:
- Form field responses: Keyed by field UUID, values vary by field type
- Metadata fields:
status: Submission status (completedorpartial)created_at: Submission creation timestampid: Submission ID (duplicate for convenience)
File Field Handling
File and signature fields are automatically processed to include download URLs:"field-uuid": [
{
"file_url": "https://api.opnform.com/open/forms/123/submissions/file/filename.pdf?expires=1756808073&signature=abc123...",
"file_name": "filename.pdf"
}
]
File URLs are signed and expire after 10 minutes for security.
Query Parameter Details
Search Functionality
- Searches within submission field values only (not field names/keys)
- Uses case-insensitive matching
- Supports partial text matching
Status Filtering
completed: Returns only fully completed submissionspartial: Returns only partially completed submissions (Pro feature)allor omitted: Returns all submissions regardless of status
Pagination
- Default
per_pageis 100, maximum is 100 - Results are ordered by
created_atin descending order (newest first)
403 Forbidden – The token lacks forms-read.Authorizations
Personal Access Token
Path Parameters
Query Parameters
Pagination page number
Required range:
x >= 1Number of results per page
Required range:
1 <= x <= 100Search term to filter submissions by field values
Filter by submission status
Available options:
completed, partial, all Was this page helpful?