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

Gets Scheme referrals via pagination

Sample Request:

GET /api/v2.0/supportschemes/SP1000000004/referrals?page=1&limit=25&filter=Live

Sample Response:
{
    "data": [
        {
             "referralId": "0cf00b4b-8b59-4e45-8412-fc16ed3e67e4",
             "reference": "REF1000000000",
             "description": "Fred Smith",
             "person": "Freddie Smith",
             "source": "Local Authority",
             "referralDate": "29/01/2024",
             "status": "Live",
             "inactive": false,
             "schemeReference": "SP0000000004"             
        },
        ...
        ...
    ],
    "page": 1,
    "total": 1,
    "limitPerPage": 25,
    "totalFilteredEntries": 0,
    "totalEntries": 1
}

Filters are "Live" - "Accepted" - "Rejected" or "Waiting%20List" and they are case sensitive
Null filter returns all data

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!