Skip to main content
GET
List submissions

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

form_id
string
required

The form's id, as shown in the dashboard and in the form's endpoint URL

Query Parameters

status
enum<string>
default:inbox

Which submissions to include: the inbox (default), spam, or both.

Available options:
inbox,
spam,
all
read
enum<string>

Only submissions that have (true) or have not (false) been read in the dashboard.

Available options:
true,
false
has_attachments
enum<string>

Only submissions with (true) or without (false) uploaded files.

Available options:
true,
false
created_after
string

Only submissions created at or after this time (RFC 3339, or milliseconds since the epoch).

created_before
string

Only submissions created before this time (RFC 3339, or milliseconds since the epoch).

country
string

Only submissions sent from this country. Two-letter uppercase code. For several, separate them with commas. Max 20.

q
string

Only submissions where any field contains this text, matched literally and without case. 2 to 512 characters. On some forms a field that only appeared in very old submissions may be missed, so name that field with a field filter.

order
enum<string>
default:newest

Newest first (the default) or oldest first.

Available options:
newest,
oldest
limit
number
default:25

Results per page.

Required range: 1 <= x <= 100
cursor
string

The next_cursor value from the previous page.

fields
string

Only return these submitted fields, separated by commas. Everything else about the submission still comes back.

Response

data
object[]
required
has_more
boolean
required

Whether another page exists. When true, request it with next_cursor.

next_cursor
string | null
required