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_properties,
payload_users,
scheme_shares
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • id_in: Filter by ID(s)
  • latest_only: Filter for latest submission versions only
  • form_in: Filter submission versions by form ID(s)
  • created_at_from: Filter submission versions created after a certain timestamp
  • created_at_to: Filter submission versions created before a certain timestamp

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
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