Skip to main content
GET
/
v3
/
orgs
/
{org_id}
/
data-capture
/
submissions
/
{submission_id}
/
versions
/
{version_id}
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{org_id}/data-capture/submissions/{submission_id}/versions/{version_id} \
  --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>"
        }
      }
    }
  },
  "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.

​
submission_id
string<uuid>
required

The unique identifier for the submission.

​
version_id
string<uuid>
required

The unique identifier for the version.

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

Response

Get a submission version.

JSON API response object

​
data
object
required

A form submission version

​
jsonapi
object
required