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>"
}
]
}
}
}
]
}Retrieve a list of properties.
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>"
}
]
}
}
}
]
}Session token for authentication.
A comma separated list of related resources to include.
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 countryFor more information on using named filters, see the docs
Limit the number of resources returned by the API
x >= 1Offset the resources returned by the API
x >= 0Get a list of properties.
JSON API response object