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

Gets linked properties of support scheme via pagination

Sample Request:

GET /api/v2.0/supportschemes/SP1000000004/properties?page=1&limit=25   

Sample Response:
{
    "data": [
        {
            "id": "1b9aca15-358a-478e-a40c-08da397a7d60",
            "uprn": "ALB38",
            "fullAddress": "38 Albert Square, Walford, London, SW8 1DA",
            "propertyStatus": "Void",
            "schemeReference": "SP1000000004" 
        },
        ...
        ...
    ],
    "page": 1,
    "total": 1,
    "limitPerPage": 25,
    "totalFilteredEntries": 0,
    "totalEntries": 1
}

MAX PER PAGE LIMIT: 500

Required Permission(s): SupportPlans.View

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!