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

Gets scheme engagement goals via pagination

Sample Request:

GET /api/v2/supportschemes/SP0000000004/engagements/SE1000000010/goals?page=1&limit=25

Sample Response:
{
    "data": [
        {
            "goalId": "ec5a4ca9-95bc-47b3-3d50-08dcde028002",
            "engagementReference": "SE1000000010",
            "description": "test new",
            "goalType": "Personal Housing Plan",
            "initialScore": 2,
            "targetScore": 4,
            "currentScore": 2,
            "isCompleted": false,
            "closeDate": null,
            "closeReason": null,
            "goalNote": "test note"
        },
        ...
        ...
    ],
    "page": 1,
    "total": 1,
    "limitPerPage": 25,
    "totalFilteredEntries": 0,
    "totalEntries": 1
}

Status filter can be add by using 'isCompleted=true' or 'isCompleted=false'
Defaults to null and brings 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!