Skip to main content
GET
/
v3
/
properties
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/properties \
  --header 'X-Session-Token: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "address": {
          "description": "<string>",
          "department": "<string>",
          "organisation": "<string>",
          "number": "<string>",
          "name": "<string>",
          "thoroughfare": "<string>",
          "dependent_thoroughfare": "<string>",
          "post_town": "<string>",
          "postcode": "<string>",
          "po_box": "<string>",
          "country": "<string>"
        },
        "uprn": 123,
        "psr": {
          "indicator": true,
          "priority": 123,
          "notes": "<string>",
          "contact": "<string>"
        },
        "meters": [
          {
            "type": "<string>",
            "number": 123
          }
        ],
        "location": {
          "british_national_grid": {
            "easting": 123,
            "northing": 123
          },
          "lat_long": {
            "latitude": 123,
            "longitude": 123
          }
        }
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "street": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "meters": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "psrs": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "counts": {
        "pages": 123,
        "resources": 123
      },
      "current_page": 123,
      "offsets": {
        "next": 123,
        "previous": 123
      },
      "requested": {
        "limit": 123,
        "offset": 123
      }
    },
    "features": {
      "include": {
        "options": [
          "<string>"
        ]
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "supply_identifier": "<string>",
        "supply_type": "MPAN",
        "serial_number": "<string>",
        "extra_info": [
          {
            "display_name": "<string>",
            "field": "<string>",
            "value": "<string>"
          }
        ]
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "uprn": 123
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "property": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "psrs": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        }
      }
    }
  ]
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
psrs,
meters
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • id: Filter by ID
  • uprn: Filter by UPRN
  • address.description: Filter by address description
  • address.department: Filter by address department
  • address.organisation: Filter by address organisation
  • address.number: Filter by address number
  • address.name: Filter by address name
  • address.thoroughfare: Filter by address thoroughfare
  • address.dependent_thoroughfare: Filter by address dependent thoroughfare
  • address.post_town: Filter by address post town
  • address.postcode: Filter by address postcode
  • address.po_box: Filter by address PO box
  • address.country: Filter by address country

For more information on using named filters, see the docs

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0

Response

Get a list of properties.

JSON API response object

data
A list of properties · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a property is returned

A meter