cURL
Properties
List properties
Retrieve a list of properties.
GET
cURL
Authorizations
Session token for authentication.
Query Parameters
A comma separated list of related resources to include.
Available options:
psrs, meters Filters the response data based on the value provided.
Available filters:
id: Filter by IDuprn: Filter by UPRNaddress.description: Filter by address descriptionaddress.department: Filter by address departmentaddress.organisation: Filter by address organisationaddress.number: Filter by address numberaddress.name: Filter by address nameaddress.thoroughfare: Filter by address thoroughfareaddress.dependent_thoroughfare: Filter by address dependent thoroughfareaddress.post_town: Filter by address post townaddress.postcode: Filter by address postcodeaddress.po_box: Filter by address PO boxaddress.country: Filter by address country
For more information on using named filters, see the docs
Limit the number of resources returned by the API
Required range:
x >= 1Offset the resources returned by the API
Required range:
x >= 0