Skip to main content
POST
List Submission Records
Returns template (checklist) submission records for the workspace derived from the API key. All body fields are optional; an empty body returns every non-draft submission. Set includeItems: false to omit per-submission answers. meta.totalCount is the total number of matching rows (for paging) and meta.count is the per-status breakdown. Results are scoped to the locations the key’s default user can access; this endpoint has no separate CAN_VIEW_REPORTING gate.

Authorizations

x-client-key
string
header
required
x-client-secret
string
header
required

Body

application/json
fromDate
string<date-time>

Start of the submission date range (filters on lastItemUpdatedAt). Requires toDate to also be set.

toDate
string<date-time>

End of the submission date range. Requires fromDate to also be set.

checklists
string<uuid>[]

Template (ChecklistId) UUIDs to include.

statuses
string[]

Submission statuses to include, e.g. "Submitted", "In Progress".

locations
string<uuid>[]

Location UUIDs. Matches the submission's default location or any hierarchy location.

users
string<uuid>[]

User UUIDs. Matches the creator, updater, or last item updater.

searchText
string

Free-text match against the template name and the submitter/updater name.

offset
integer
default:0

Row offset for paging.

limit
integer
default:1000000

Maximum rows to return. Defaults to effectively all rows.

includeItems
boolean
default:true

When true, each submission includes its answered items and sections (TaskChecklistItems / TaskChecklistSections).

Response

Submission records retrieved successfully.