Permits
Get a Permit
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
Permits
Get a Permit
Returns an permit
GET
/
v3
/
orgs
/
{orgId}
/
governance
/
schemes
/
{schemeId}
/
work-orders
/
{workOrderId}
/
permits
/
{permitId}
curl --request GET \
--url https://api.ctrl-hub.com/v3/orgs/{orgId}/governance/schemes/{schemeId}/work-orders/{workOrderId}/permits/{permitId} \
--header 'Authorization: Bearer <token>'
{
"data": {
"type": "permits",
"id": "bcbdf616-6dd9-4ad6-a01b-b451a0c1205a",
"attributes": {
"reference": "REF001",
"description": "DESC-123456",
"proposed_start_date": "2024-06-13T00:00:00.000Z",
"proposed_end_date": "2024-08-13T00:00:00.000Z"
},
"meta": {
"created_at": "2024-06-13T07:15:23.000Z",
"updated_at": "2024-06-13T07:15:23.000Z",
"status": "granted"
},
"links": {
"self": "https://api.ctrl-hub.com/v3/governance/schemes/5852cf16-8ec8-4aba-809e-f8d828772c4e/work-orders/5852cf16-8ec8-4aba-809e-f8d828772c4e/permits/5852cf16-8ec8-4aba-809e-f8d828772c4e"
}
}
}
Authorizations
To understand how to authenticate, see the auth docs
Path Parameters
The ID of the organisation
The ID of the scheme
The ID of the work order
The ID of the permit
Response
200
application/json
The resource type
Available options:
permits
The ID of the permit
curl --request GET \
--url https://api.ctrl-hub.com/v3/orgs/{orgId}/governance/schemes/{schemeId}/work-orders/{workOrderId}/permits/{permitId} \
--header 'Authorization: Bearer <token>'
{
"data": {
"type": "permits",
"id": "bcbdf616-6dd9-4ad6-a01b-b451a0c1205a",
"attributes": {
"reference": "REF001",
"description": "DESC-123456",
"proposed_start_date": "2024-06-13T00:00:00.000Z",
"proposed_end_date": "2024-08-13T00:00:00.000Z"
},
"meta": {
"created_at": "2024-06-13T07:15:23.000Z",
"updated_at": "2024-06-13T07:15:23.000Z",
"status": "granted"
},
"links": {
"self": "https://api.ctrl-hub.com/v3/governance/schemes/5852cf16-8ec8-4aba-809e-f8d828772c4e/work-orders/5852cf16-8ec8-4aba-809e-f8d828772c4e/permits/5852cf16-8ec8-4aba-809e-f8d828772c4e"
}
}
}