List plans ending soon

{
  "data": [
    {
      "participant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "participant_number": "NDIS-123456789",
      "display_name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "plan_start_date": "2024-06-01",
      "plan_end_date": "2024-06-30",
      "is_pace_plan": false,
      "prev_plan_start_date": "2023-06-01",
      "prev_plan_end_date": "2024-05-31",
      "account_manager": "7b9e8f3a-4d2c-4f1a-9f3e-1a2b3c4d5e6f",
      "account_manager_name": "Emily Smith"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 5,
    "has_more": true
  }
}

Participants whose current plan end date is today or in the future, soonest first. Requires X-Plan-Manager-Id header.

Authentication

AuthorizationBearer

API key issued for your account. Send as Bearer token in the Authorization header.

X-Plan-Manager-Idstring

Plan manager UUID. Required on all public API requests to scope data access.

Query parameters

account_managersstringOptional

Filter by account manager user IDs (comma-separated UUIDs)

limitintegerOptional1-100Defaults to 20

Items per page

offsetintegerOptional>=0Defaults to 0

Number of items to skip

Response

List of plans ending soon

datalist of objects

paginationobject

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error

$	curl https://api.caresquareapi.com/api/public/v1/notifications/plans-ending-soon \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"