Skip to main content
GET
/
v3
/
orgs
/
{org_id}
/
data-capture
/
forms
/
{form_id}
/
submissions
/
{submission_id}
/
versions
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{org_id}/data-capture/forms/{form_id}/submissions/{submission_id}/versions \
  --header 'X-Session-Token: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "payload": {},
        "iteration": 2,
        "resources": [
          {
            "data": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "images",
              "attributes": {},
              "relationships": {},
              "meta": {}
            },
            "jsonapi": {
              "version": "<string>"
            }
          }
        ]
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "latest": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "is_latest": true
      },
      "relationships": {
        "author": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "payload_images": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "payload_schemes": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "payload_work_orders": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "payload_operations": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "payload_properties": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "payload_users": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "submission": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "schema": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "form": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "counts": {
        "pages": 123,
        "resources": 123
      },
      "current_page": 123,
      "offsets": {
        "next": 123,
        "previous": 123
      },
      "requested": {
        "limit": 123,
        "offset": 123
      }
    },
    "features": {
      "include": {
        "options": [
          "<string>"
        ]
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  }
}

Authorizations

​
X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

​
org_id
string<uuid>
required

The unique identifier for the organisation.

​
form_id
string<uuid>
required

The unique identifier for the form.

​
submission_id
string<uuid>
required

The unique identifier for the submission.

Query Parameters

​
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
author,
form,
organisation,
schema,
submission,
payload_images,
payload_operations,
payload_properties,
payload_users
​
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
  • payload_images: Filter submission versions by related image ID(s)
  • payload_users: Filter submission versions by related user ID(s)
  • payload_operations: Filter submission versions by related operation ID(s)
  • payload_work_orders: Filter submission versions by related work order ID(s)
  • payload_schemes: Filter submission versions by related scheme ID(s)
  • payload_properties: Filter submission versions by related property ID(s)
  • 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

Response

Get a list of form submission versions.

JSON API response object

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