List form submissions

curl --request GET \
  --url https://api.paubox.com/v1/forms/api/forms/{form_id}/submissions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.paubox.com/v1/forms/api/forms/{form_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.paubox.com/v1/forms/api/forms/{form_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.paubox.com/v1/forms/api/forms/{form_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.paubox.com/v1/forms/api/forms/{form_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))

}

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/forms/api/forms/{form_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": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "form_id": "550e8400-e29b-41d4-a716-446655440000",
      "form_data": "{\"first_name\":\"Jane\",\"last_name\":\"Smith\",\"email\":\"jane@example.com\"}",
      "storage_type": "S3",
      "storage_url": null,
      "submitter_email": "jane@example.com",
      "recipients": "intake@example.com",
      "attachment_name": null,
      "attachment_url": null,
      "attachment_type": null,
      "attachment": null,
      "created_at": "2024-06-05T14:22:00Z"
    }
  ],
  "total": 42,
  "page": 1,
  "items": 50
}

GET

api

forms

{form_id}

submissions

List form submissions

curl --request GET \
  --url https://api.paubox.com/v1/forms/api/forms/{form_id}/submissions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.paubox.com/v1/forms/api/forms/{form_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.paubox.com/v1/forms/api/forms/{form_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.paubox.com/v1/forms/api/forms/{form_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.paubox.com/v1/forms/api/forms/{form_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))

}

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/forms/api/forms/{form_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": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "form_id": "550e8400-e29b-41d4-a716-446655440000",
      "form_data": "{\"first_name\":\"Jane\",\"last_name\":\"Smith\",\"email\":\"jane@example.com\"}",
      "storage_type": "S3",
      "storage_url": null,
      "submitter_email": "jane@example.com",
      "recipients": "intake@example.com",
      "attachment_name": null,
      "attachment_url": null,
      "attachment_type": null,
      "attachment": null,
      "created_at": "2024-06-05T14:22:00Z"
    }
  ],
  "total": 42,
  "page": 1,
  "items": 50
}

Authorizations

Authorization

string

header

required

Paubox API key sent as Authorization: Bearer YOUR_API_KEY. API keys are created in the Paubox dashboard and must have the "forms" scope; a key without the forms scope receives 401 Unauthorized. A valid key used against a resource that belongs to a different customer receives 403 Forbidden.

Path Parameters

form_id

string<uuid>

required

UUID of the form

Query Parameters

submission_id

string<uuid>

Filter the results to a single submission by its UUID.

order_by

enum<string>

default:created_at

Field to order results by.

Available options:

created_at,

submitter_email

order

enum<string>

default:desc

Sort direction.

Available options:

asc,

desc

page

integer

default:1

Page number to return.

items

integer

default:50

Number of submissions per page (maximum 100).

Required range: x <= 100

Response

Paginated list of submissions

data

object[]

Show child attributes

total

integer

Total number of matching submissions

page

integer

Current page number

items

integer

Number of items per page

⌘I

Email API · Messages

Email API · Dynamic templates

Marketing · Campaigns

Marketing · Drip campaigns

Marketing · Subscribers

Marketing · Subscription lists

Marketing · Tracking links

Marketing · Analytics

Forms API

List form submissions

Authorizations

Path Parameters

Query Parameters

Response