Skip to main content
GET
List Submissions

List Submissions

Retrieve submissions for a specific form.

Authentication & Scope

Requires forms-read ability.

Request

Path Parameters

Query Parameters

Response

200 OK – Returns a paginated collection of Submission objects.

Response Fields

Each submission object contains:

Data Object Structure

The data object contains:
  • Form field responses: Keyed by field UUID, values vary by field type
  • Metadata fields:
    • status: Submission status (completed or partial)
    • created_at: Submission creation timestamp
    • id: Submission ID (duplicate for convenience)

File Field Handling

File and signature fields are automatically processed to include download URLs:
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 submissions
  • partial: Returns only partially completed submissions (Pro feature)
  • all or omitted: Returns all submissions regardless of status

Pagination

  • Default per_page is 100, maximum is 100
  • Results are ordered by created_at in descending order (newest first)
403 Forbidden – The token lacks forms-read.

Authorizations

Authorization
string
header
required

Personal Access Token

Path Parameters

id
number
required

Query Parameters

page
number
default:1

Pagination page number

Required range: x >= 1
per_page
number
default:100

Number of results per page

Required range: 1 <= x <= 100

Search term to filter submissions by field values

status
enum<string>
default:all

Filter by submission status

Available options:
completed,
partial,
all

Response

Successful

data
object[]
meta
object