Search submitted form records
list_form_submissionsSearch submitted records from a WorkMobile form by date, job, mobile user, group, or field values; returns record IDs and answers with personal data withheld by default.
Instructions
Search the records submitted on one form (POST /api/forms/{FormId}/completedrecords/search): by created or uploaded date, job, mobile user, user group, or searchable field values. Each record comes back with its Id, OriginalId and JobId, the system columns, and the answers. Unless include_contact_details is set, answers in fields whose names mark them as personal (names, contact details, addresses, postcodes, signatures, photos, locations, dates of birth, health, pay) and links to media are withheld; in other answers, emails, phone numbers, postcodes and coordinates are redacted, but names and street addresses typed into free text are not. This search is a POST request that only reads. Pages hold 500 records.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page to start from (pages hold 500 rows, the smallest page size the API allows) | |
| job_id | No | Records relating to this job (API `jobId`) | |
| form_id | Yes | Form ID (a positive whole number) | |
| max_pages | No | Pages of 500 to fetch in this call | |
| created_to | No | Records created on or before this (API `createdDateTo`). A date alone means 23:59:59 UTC. | |
| user_group | No | Records from users in this user group (API `userGroup`) | |
| max_results | No | Most rows to return; rows beyond this on pages already fetched are counted, not returned | |
| uploaded_to | No | Records uploaded on or before this (API `uploadedDateTo`) | |
| created_from | No | Records created on or after this (API `createdDateFrom`). A date alone means 00:00:00 UTC. | |
| newest_first | No | Order by record Id, newest first (the documented orderBy example) or oldest first | |
| field_filters | No | User-defined field filters (API `userDefinedFilter`). Different fields are ANDed; the same field given twice is ORed. | |
| uploaded_from | No | Records uploaded from the device on or after this (API `uploadedDateFrom`) | |
| mobile_user_id | No | Records collected by this mobile user (API `mobileUserId`) | |
| include_contact_details | No | Include personal answers and links to media (never downloaded), and stop redacting emails, phone numbers, postcodes and coordinates in other answers. Off by default. Bank, card and payment details are never returned. |