GET
/
v3
/
orgs
/
{orgId}
/
data-capture
/
submissions
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

200
application/json
​
data
object[]
​
meta
object
​
links
object