GET
/
v3
/
governance
/
properties
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/governance/properties \
  --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"
        }
      }
    }
  ]
}
Bounded Boxes allow you to search for properties within a specific area. This is useful for finding properties within a specific area, usually to display on a map.To search for properties within a bounded box, you need to supply two pieces of data with the request: the top right and bottom left coordinates of the box.The API will then return a list of properties that fall within the box that can be drawn from those two coordinates.

Authorizations

​
Authorization
string
header
required

To understand how to authenticate, see the auth docs

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

​
filter[location.box.bottom_left]
string

The bottom left corner of bounding box to filter by

Example:

"51.5074,0.1278"

​
filter[location.box.top_right]
string

The top right corner of bounding box to filter by

Example:

"51.6123,0.378"

Response

200
application/json

The response is of type object.