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

Gets support schemes via pagination

Sample Request:

GET /api/v2.0/supportschemes?page=1&limit=25&since=15/05/2022&activeOnly=true      

Sample Response:
{
    data": [
        {
            "id": "ba5ccac6-36fe-489a-6faa-08db7c79d009",
            "reference": "SP0000000001",
            "description": "Tenancy Sustainment in Walford Funded Suport",
            "floating": false,
            "isInactive": false,
            "capacity": 20,
            "maxGoalScore": 5,
            "dateRaised": "04/07/2023 11:31"
        },
        ...
        ...
    ],
    "page": 1,
    "total": 1,
    "limitPerPage": 25,
    "totalFilteredEntries": 0,
    "totalEntries": 6
}

"since" must be in (DD/MM/YYYY) format. Defaults to 01/01/1970
"activeOnly" Defaults to true

MAX PER PAGE LIMIT: 500

Required Permission(s): SupportPlans.View

Log in to see full request history
Query Params
int32
Defaults to 1

The current page number requested. Defaults to 1.

int32
Defaults to 25

The max number of items to return. Defaults to 25

boolean
Defaults to true

Whether or not to only get active Schemes. Defaults to true

string
Defaults to 01/01/1970

Filters Support Schemes to find Scheme that have been built on or after the given date. Defaults to 01/01/1970

Responses

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json