Submissions
Get a Submission
API Documentation
Governance
- Organisations
- Schemes
- Work Orders
- Permits
- Operations
- Properties
- Streets
Data Capture
- Forms
- Form Categories
- Submissions
- Submission Versions
Operations
- Reinstatements
Assets
- Vehicles
Admin
- IAM
Submissions
Get a Submission
Returns a submission
GET
/
v3
/
orgs
/
{orgId}
/
data-capture
/
submissions
/
{submissionId}
curl --request GET \
--url https://api.ctrl-hub.com/v3/orgs/{orgId}/data-capture/submissions/{submissionId} \
--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"
}
}
}
Authorizations
To understand how to authenticate, see the auth docs
Path Parameters
The ID of the organisation
The ID of the submission
Response
200
application/json
The resource type
Available options:
submissions
The ID of the submission
curl --request GET \
--url https://api.ctrl-hub.com/v3/orgs/{orgId}/data-capture/submissions/{submissionId} \
--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"
}
}
}