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:
author,
form,
organisation,
schema,
submission,
payload_images,
payload_videos,
payload_operations,
payload_work_orders,
payload_schemes,
payload_contracts,
payload_properties,
payload_users,
payload_meters,
payload_vehicles,
payload_equipment_items,
scheme_shares
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • in(submission,[xxx]): Filter submission versions by submission ID(s), e.g. eq(submission,xxx) for every version of one submission
  • in(id,[xxx]): Filter by submission ID(s). Matches the same field as submission, not the version's own ID
  • in(form,[xxx]): Filter submission versions by form ID(s)
  • in(schema,[xxx]): Filter submission versions by the schema they were captured on
  • in(organisation,[xxx]): Filter submission versions by organisation ID(s)
  • in(author.id,[xxx]): Filter submission versions by author ID(s)
  • status: Filter by draft or submitted, e.g. eq(status,submitted)
  • eq(is_latest,true): Filter for the latest version of each submission only
  • ge(created_at,<date-time>): Filter submission versions created at or after an RFC 3339 timestamp
  • le(created_at,<date-time>): Filter submission versions created at or before an RFC 3339 timestamp
  • in(related_resources.id,[xxx]): Filter submission versions by related resource ID(s)
  • in(scheme_shares,[xxx]): Filter submission versions by scheme share ID(s)

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 submission versions.

JSON API response object

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

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

A form