Interested Applicants
Get a single Interested Applicant.
Changed onThis endpoint retrieves a single interested applicant by its UUID.
get/interested-applicants/{interested_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.
Response
Get Interested Applicant by UUID.
Example response
{
"data": {
"relationships": {
"applicant": {
"data": {
"id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
}
},
"property": {
"data": {
"id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
}
}
}
},
"included": [
{
"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": {
"people": {
"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