Skip to main content
GET
Search submissions across forms

Authorizations

Authorization
string
header
required

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

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

Matches to return in total across every form searched. This search has no pages.

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

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

team_id
string

Search this team only. Defaults to every team the key covers.

form_ids
string

Search only these forms, separated by commas. Forms the key cannot read are left out whether or not you name them. Defaults to the 25 most recently active forms the key can read.

Response

data
object[]
required

Matches across the forms searched, each carrying its form_id.

forms_searched
number
required

How many of forms_matched were read before the search stopped.

Example:

12

forms_matched
number
required

Forms picked for the search: the ones the key can read that matched form_ids, at most 25.

Example:

14

complete
boolean
required

False when the search did not reach every form or every match. Narrow it with form_ids, a date range or team_id.