List submissions
list_submissionsSubmissions of one form, newest first. Search in this order: read a page of recent submissions to see the field names people are sending now, widen that list with get_form_fields when you need more names, use q for a first pass when you do not know which field holds the text, then narrow with field filters. When you do not know how many submissions an answer covers, call count_submissions before paging through them, and when you do not know what values a field holds, call it with group_by field: and select the ones you want with a field in filter. Filters combine with AND: q, status (inbox, spam, all), read, has_attachments, created_after, created_before, country, and up to 5 field filters (eq, contains, starts_with, exists, in). Pass fields to return only the values you need when you are scanning many submissions. Follow next_cursor until it is null. Not possible here, so say so rather than approximating: no totals in this tool, no "not equal" or "does not contain", no greater than or less than on a value, and no sorting by anything but time. To compare numbers, filter to the submissions that have the field, pass fields to read just that value, and compare them yourself.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Any field contains this text, matched literally and without case. Use it first when you do not know which field holds the text. On some forms it covers only the fields recent submissions carry, so reach an older field by name with a field filter. | |
| read | No | Only read (true) or unread (false) submissions. | |
| field | No | Up to 5 filters keyed by field name, spelled the way the submissions spell it. Each is an object with one of eq, contains, starts_with, exists or in. Several filters combine with AND. Example: {"email": {"contains": "@example.com"}, "plan": {"in": ["pro", "team"]}}. | |
| limit | No | Submissions per page. Keep it small. | |
| order | No | Newest first (default) or oldest first. | newest |
| cursor | No | ||
| fields | No | Only return these submitted fields, separated by commas, such as "email,name". Use it when you are scanning many submissions for one or two values, so the rest does not come back. | |
| status | No | inbox | |
| country | No | Two-letter uppercase country code. For several, separate them with commas, such as "DE,AT,CH". Max 20. | |
| form_id | Yes | Form id, a short string such as "AbC123xyz" (from list_forms). | |
| created_after | No | RFC 3339 date or time, inclusive. | |
| created_before | No | RFC 3339 date or time, exclusive. | |
| has_attachments | No |