Properties
Get a Property
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
Properties
Get a Property
Find a property by UPRN
GET
/
v3
/
governance
/
properties
/
{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
Example:
10022999531
Response
200
application/json
The response is of type object
.
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"
}
}
}
}