Applicants
Get a single Sales Applicant
Changed onThis endpoint retrieves a single applicant by its UUID.
get/sales-applicants/{applicant_id}
Request
- Base URLhttps://street.co.uk/open-api/v1
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
includestring[]
Optional related entities to include in the results, e.g. branch,offers,viewings,people,notes,sales
Response
OK.
Example response
{
"data": {
"attributes": {
"name": "Dave Smith & Helen Bloggs",
"financial_position": "Agreement in Principle in place",
"buying_position": "Property to sell",
"requirements": {
"property_type_preference": {
"house": "Don't Mind",
"flat": "Might Consider",
"semi_detached": "Would Prefer"
},
"new_property_type_preference": {
"house": "Don't Mind",
"flat": "Might Consider",
"semi_detached": "Would Prefer"
},
"areas": [
"Ellesmere Park"
]
}
},
"relationships": {
"branch": {
"data": {
"id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
}
},
"viewings": {
"data": [
{
"id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
}
]
},
"offers": {
"data": [
{
"id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
}
]
},
"people": {
"data": [
{
"id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
}
]
},
"notes": {
"data": [
{
"id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
}
]
},
"sales": {
"data": [
{
"id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
}
]
},
"followUps": {
"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
}
}
}
}
]
}Changes
- info
added the optional property
/////to the response with the status - info
added the optional property
//////to the response with the status
- info