Get Submissions

cURL

curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{orgId}/data-capture/submissions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "type": "submissions",
      "id": "eb2b4aa7-048d-470b-b504-a3eb3bf45e29",
      "attributes": {
        "reference": "1234A567BCD",
        "status": "complete"
      },
      "meta": {
        "created_at": "2024-06-13T07:15:23.000Z",
        "updated_at": "2024-06-13T07:15:23.000Z"
      },
      "relationships": {
        "form": {
          "data": {
            "type": "forms",
            "id": "feabf5d3-91b4-42ad-b145-8bee6c115b78"
          }
        },
        "form_version": {
          "data": {
            "type": "form-versions",
            "id": "03c37271-70bb-4f03-955d-b4fcbe252a15"
          }
        },
        "author": {
          "data": {
            "type": "users",
            "id": "c9927007-a8e3-46bc-b507-7867b114bef5"
          }
        },
        "versions": {
          "data": [
            {
              "type": "submission-versions",
              "id": "f7bd5f57-8b79-40c5-bb80-acf82b068da0"
            }
          ]
        }
      },
      "links": {
        "self": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/submissions/eb2b4aa7-048d-470b-b504-a3eb3bf45e29"
      }
    }
  ],
  "meta": {
    "counts": {
      "limit": 10
    },
    "page": {
      "limit": 10,
      "offset": {
        "current": 20,
        "next": 30,
        "previous": 10
      }
    }
  },
  "links": {
    "current": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/data-capture/submissions?limit=10&offset=20",
    "next": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/data-capture/submissions?limit=10&offset=30",
    "previous": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/data-capture/submissions?limit=10&offset=10"
  }
}

GET

orgs

{orgId}

data-capture

submissions

cURL

curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{orgId}/data-capture/submissions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "type": "submissions",
      "id": "eb2b4aa7-048d-470b-b504-a3eb3bf45e29",
      "attributes": {
        "reference": "1234A567BCD",
        "status": "complete"
      },
      "meta": {
        "created_at": "2024-06-13T07:15:23.000Z",
        "updated_at": "2024-06-13T07:15:23.000Z"
      },
      "relationships": {
        "form": {
          "data": {
            "type": "forms",
            "id": "feabf5d3-91b4-42ad-b145-8bee6c115b78"
          }
        },
        "form_version": {
          "data": {
            "type": "form-versions",
            "id": "03c37271-70bb-4f03-955d-b4fcbe252a15"
          }
        },
        "author": {
          "data": {
            "type": "users",
            "id": "c9927007-a8e3-46bc-b507-7867b114bef5"
          }
        },
        "versions": {
          "data": [
            {
              "type": "submission-versions",
              "id": "f7bd5f57-8b79-40c5-bb80-acf82b068da0"
            }
          ]
        }
      },
      "links": {
        "self": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/submissions/eb2b4aa7-048d-470b-b504-a3eb3bf45e29"
      }
    }
  ],
  "meta": {
    "counts": {
      "limit": 10
    },
    "page": {
      "limit": 10,
      "offset": {
        "current": 20,
        "next": 30,
        "previous": 10
      }
    }
  },
  "links": {
    "current": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/data-capture/submissions?limit=10&offset=20",
    "next": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/data-capture/submissions?limit=10&offset=30",
    "previous": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/data-capture/submissions?limit=10&offset=10"
  }
}

Authorizations

Authorization

string

header

required

To understand how to authenticate, see the auth docs

Path Parameters

orgId

string

required

The ID of the organisation

Example:

"cc9746e0-9286-4575-ae0b-ac1b0fe873a6"

Query Parameters

limit

integer

default:10

Limit the number of resources returned by the API

offset

integer

default:0

Offset for resources returned by the API

sort

string

default:created_at

A field in the resource to sort results with. Not all attributes are supported, please see the Object Model for sortable fields.

Response

data

object[]

Show child attributes

data.type

enum<string>

The resource type

Available options:

submissions

Example:

"submissions"

data.id

string<uuid>

The ID of the submission

Example:

"eb2b4aa7-048d-470b-b504-a3eb3bf45e29"

data.attributes

object

Show child attributes

data.attributes.reference

string

The reference of the submission

Example:

"1234A567BCD"

data.attributes.status

string

The status of the submission - this is always the latest status based on the submission versions

Example:

"complete"

data.meta

object

Show child attributes

data.meta.created_at

string

Sortable. The time the submission was created (RFC 3339)

Example:

"2024-06-13T07:15:23.000Z"

data.meta.updated_at

string

Sortable. The time the submission was updated (RFC 3339)

Example:

"2024-06-13T07:15:23.000Z"

data.relationships

object

Show child attributes

data.relationships.form

object

The id of form this submission relates to

Show child attributes

data.relationships.form.data

object

Show child attributes

data.relationships.form.data.type

enum<string>

The resource type

Available options:

forms

Example:

"forms"

data.relationships.form.data.id

string<uuid>

The ID of the form

Example:

"feabf5d3-91b4-42ad-b145-8bee6c115b78"

data.relationships.form_version

object

The id of the form version this submission version relates to

Show child attributes

data.relationships.form_version.data

object

Show child attributes

data.relationships.form_version.data.type

enum<string>

The resource type

Available options:

form-versions

Example:

"form-versions"

data.relationships.form_version.data.id

string<uuid>

The ID of the form version

Example:

"03c37271-70bb-4f03-955d-b4fcbe252a15"

data.relationships.author

object

The id of user this submission relates to

Show child attributes

data.relationships.author.data

object

Show child attributes

data.relationships.author.data.type

enum<string>

The resource type

Available options:

users

Example:

"users"

data.relationships.author.data.id

string<uuid>

The ID of the user

Example:

"c9927007-a8e3-46bc-b507-7867b114bef5"

data.relationships.versions

object

The id's of versions this submission relates to

Show child attributes

data.relationships.versions.data

object[]

Show child attributes

data.relationships.versions.data.type

enum<string>

The resource type

Available options:

submission-versions

Example:

"submission-versions"

data.relationships.versions.data.id

string<uuid>

The ID of the submission version

Example:

"f7bd5f57-8b79-40c5-bb80-acf82b068da0"

data.links

object

Show child attributes

data.links.self

string

Example:

"https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/submissions/eb2b4aa7-048d-470b-b504-a3eb3bf45e29"

API Documentation

Governance

Data Capture

Operations

Assets

Admin

Authorizations

Path Parameters

Query Parameters

Response