Branches
Get a single Branch
Changed onThis endpoint retrieves a single branch by its UUID.
get/branches/{branch_id}
Request
- Base URLhttps://street.co.uk/open-api/v1
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
branch_idstring uuid required
The UUID of the Branch.
Query parameters
includestring[]
Optional related entities to include in the results.
Response
OK.
Example response
{
"data": {
"attributes": {
"address": {
"single_line": "19 Lansdowne Road, Monton, Manchester",
"anon_single_line": "Lansdowne Road, Monton, Manchester",
"building_number": "19",
"line_1": "19 Lansdowne Road",
"line_2": "Monton",
"line_3": "Manchester",
"town": "Manchester",
"country": "United Kingdom",
"postcode": "M30 9PA",
"udprn": "28327204",
"geo": {
"lat": 0.2365698,
"lng": 53.023654
}
}
},
"relationships": {
"users": {
"data": [
{
"id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
}
]
},
"properties": {
"data": [
{
"id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
}
]
},
"applicants": {
"data": [
{
"id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
}
]
}
}
},
"included": [
{
"attributes": {
"address": {
"single_line": "19 Lansdowne Road, Monton, Manchester",
"anon_single_line": "Lansdowne Road, Monton, Manchester",
"building_number": "19",
"line_1": "19 Lansdowne Road",
"line_2": "Monton",
"line_3": "Manchester",
"town": "Manchester",
"country": "United Kingdom",
"postcode": "M30 9PA",
"udprn": "28327204",
"geo": {
"lat": 0.2365698,
"lng": 53.023654
}
},
"material_information": {
"council_tax_band": "D"
}
},
"relationships": {
"branch": {
"data": {
"id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
}
}
}
}
]
}Changes
- info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
//////to the response with the status - info
added the optional property
//////to the response with the status
- info
- info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status
- info