List form submissions

GET/app/v1/form-submission/

Filled-in forms.

Open one for somebody (POST), save answers (PATCH), hand it in (submit), hide it (archive). There is no DELETE: a handed-in form is a record of what somebody signed, so it is archived, never destroyed.

Authorization

X-API-KEYstring · headerrequired

Your company's API key.

Query parameters

archivedboolean

true to list archived forms instead.

assigned_tointeger

Team member id.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

Match on form name or the person's name.

statusstring

not_started, in_progress, needs_review, changes_requested, approved, denied, completed. Comma-separate for several.

templatestring

Template id (UUID).

Response

200A page of records in data
idstring (uuid)
templatestring
assigned_tostring
assigned_bystring
reviewed_bystring
due_datestring (date)
submitted_atstring (date-time)
is_duestring
statusstring
archivedboolean
review_notestring
filled_bystring
vehiclestring
trailerstring
driver_refstring
started_atstring (date-time)
reviewed_atstring (date-time)
created_atstring (date-time)
updated_atstring (date-time)
answer_rowsstring
require_approvalsboolean
mediaarray of object
Show fields
idstring (uuid)
submissionstring (uuid)
block_refstring
urlstring
media_typeenum

One of: image signature

created_atstring (date-time)