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

Log in to see full request history
Path Params
string
required

The Support Scheme reference

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

string

Gets the data using by filter keywords. Defaults to all

Responses

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