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

Gets scheme handover notes via pagination

Sample Request:

GET /api/v2/supportschemes/SP0000000004/handovernotes?page=1&limit=25&isClosed=true

Sample Response:
{
    "data": [
        {
            "handoverNoteId": "5ede5e91-5464-473b-293b-08dcdeddd1b0",
            "schemeReference": "SP1000000006",
            "title": "Handover note title",
            "description": "Handover note description",
            "recordType": "Manuel Record",
            "priority": "High Level",
            "createdDate": "27/09/2024",
            "isClosed": true,
            "closedDate": "27/09/2024",
            "createdBy": "[email protected]",
            "backgroundColour": "#ff0000",
            "linkedEngagementReference": null      
        },
        ...
        ...
    ],
    "page": 1,
    "total": 1,
    "limitPerPage": 25,
    "totalFilteredEntries": 0,
    "totalEntries": 1
}

isClosed defaults to null and brings all data.
You can add true or false to add a filter.

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!