These docs are for v2.3. Click to read the latest docs for v3.0.

Gets linked property of a support scheme based on url

get

https://{tenant}.rubixx.app/api/v2/supportschemes/{supportSchemeReference}/properties/{uprn}

Sample Request:

GET /api/v2.0/supportschemes/SP1000000004/properties/COR07

{
"id": "1b9aca15-358a-478e-a40c-08da397a7d60",
"uprn": "ALB38",
"fullAddress": "38 Albert Square, Walford, London, SW8 1DA",
"propertyStatus": "Void",
"schemeReference": "SP1000000004"
}

Required Permission(s): SupportPlans.View

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200On Success with the paginated collection of Support Scheme Properties

400If the request is malformed or incorrect

401If the supplied token is not correct

403If the provided bearer token cannot perform the current request due to a lack of permissions

404If the requested resource cannot be found

500An internal server error