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
Get a Property
Find a property by UPRN
curl --request GET \
--url https://api.ctrl-hub.com/v3/governance/properties/{uprn} \
--header 'Authorization: Bearer <token>'{
"data": {
"type": "properties",
"id": "7e0c875a-fd47-401d-bd25-4278ed58d721",
"attributes": {
"uprn": 10022999531,
"address": {
"country": "United Kingdom",
"department": "Finance",
"dependent_thoroughfare": "Dependent Thoroughfare Name",
"description": "Saltmeadows Rd, Gateshead NE8 3AH",
"name": "Highway House",
"number": "1A",
"organisation": "Ctrl Hub Limited",
"pobox": "PO Box 123",
"post_town": "Gateshead",
"postcode": "NE8 3AH",
"thoroughfare": "Saltmeadows Rd"
},
"location": {
"coordinates": [
-1.587305,
54.966
],
"type": "Point"
},
"mprn": 1515151,
"mpan": 5151515,
"psr": {
"indicator": true,
"contact": "A Person (07970 111 222)",
"priority": 1,
"notes": "14Pensioner"
}
}
}
}Authorizations
To understand how to authenticate, see the auth docs
Path Parameters
The UPRN of the property
Response
The type of resource
properties The property ID
The Unique Property Reference Number
The property address
The country of the property
The department of the organisation if this property is commercial
The dependent thoroughfare of the property
A description of the property which is searchable via a typeahead
The name of the property
The number of the property
The name of the organisation
If the address has a POBox, it will be present here
The postal town of the property
The postcode of the property
The thoroughfare of the property
The MPRN at the property
The MPAN at the property
The PSR details of the property
Whether the property is on the PSR or not
The contact details of the PSR customer
The priority of the vulnerable customer. This is 0 when there is no priority.
0, 1, 2, 3 Any notes about the vulnerable customer which will potentially include the Needs Codes
curl --request GET \
--url https://api.ctrl-hub.com/v3/governance/properties/{uprn} \
--header 'Authorization: Bearer <token>'{
"data": {
"type": "properties",
"id": "7e0c875a-fd47-401d-bd25-4278ed58d721",
"attributes": {
"uprn": 10022999531,
"address": {
"country": "United Kingdom",
"department": "Finance",
"dependent_thoroughfare": "Dependent Thoroughfare Name",
"description": "Saltmeadows Rd, Gateshead NE8 3AH",
"name": "Highway House",
"number": "1A",
"organisation": "Ctrl Hub Limited",
"pobox": "PO Box 123",
"post_town": "Gateshead",
"postcode": "NE8 3AH",
"thoroughfare": "Saltmeadows Rd"
},
"location": {
"coordinates": [
-1.587305,
54.966
],
"type": "Point"
},
"mprn": 1515151,
"mpan": 5151515,
"psr": {
"indicator": true,
"contact": "A Person (07970 111 222)",
"priority": 1,
"notes": "14Pensioner"
}
}
}
}