Skip to main content
GET
cURL

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:

  • eq(id,xxx): Filter by ID.
  • eq(uprn,xxx): Filter by UPRN.
  • in(uprn,[xxx,yyy]): Filter by multiple UPRNs.

For more information on using 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