Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
contributors,
creator,
form,
organisation,
versions,
scheme_shares,
workflow,
workflow_instance,
workflow_version,
payload_users,
payload_operations,
payload_work_orders,
payload_schemes,
payload_contracts,
payload_images,
payload_videos,
payload_properties,
payload_meters,
payload_vehicles
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • in(id,[xxx]): Filter by ID(s)
  • contains(short_id,xxx): Search submissions by their short ID — the reference shown in the UI (the first 8 hex characters of the full ID), e.g. contains(short_id,3b6f0147). Case-insensitive; partial (substring) match.
  • in(contributor.id,[xxx]): Filter submissions by contributor ID(s)
  • in(creator.id,[xxx]): Filter submissions by creator ID(s)
  • in(form,[xxx]): Filter submissions by form ID(s)
  • in(schema,[xxx]): Filter submissions by schema ID(s). Matches a submission if any of its versions was captured on one of the schemas, so a submission amended onto a newer schema is found by both its original and its newer schema
  • in(related_resources.id,[xxx]): Filter submissions by related resource ID(s) (mirrored from the latest version). Also matches the work orders, schemes and contracts above an operation, work order or scheme the submission references, so a scheme ID finds the submissions under it
  • eq(contract,xxx): Filter submissions by scheme contract. Matches a submission whose latest version references an operation, work order or scheme under the contract, or names the contract itself. Follows the contract's current schemes, so relinking a scheme moves its existing submissions to the new contract
  • eq(scheme,xxx): Filter submissions by scheme, including those that reference an operation or work order under it
  • eq(work-order,xxx): Filter submissions by work order, including those that reference an operation under it
  • eq(operation,xxx): Filter submissions by operation

For more information on using named filters, see the docs

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
page
object

JSON:API pagination, as page[limit] and page[offset]. The same as the top-level limit and offset parameters; when both forms are sent, page[...] wins.

sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
created_at,
-created_at

Response

Get a list of submissions for a form.

JSON API response object

data
A list of form submissions · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a form submission is returned

A user