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:
organisation,
property,
meter
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • id: Filter by ID
  • organisation: Filter by organisation
  • property: Filter by property ID
  • uprn: Filter by UPRN
  • meter: Filter by meter ID
  • meter_supply_identifier: Filter by meter supply identifier
  • priority: Filter by priority
  • extra_info.display_name: Filter by display name
  • extra_info.field: Filter by extra info field
  • extra_info.value: Filter by extra info value

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 PSR records.

JSON API response object

data
object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a PSR record is returned

An organisation