Skip to navigation

List plans ending soon

Participants whose current plan end date is today or in the future (using the Australia/Sydney date). Requires X-Plan-Manager-Id header. Ordering: by plan_end_date ascending (soonest to end first).

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)

is_pace_planbooleanOptional
Filter by PACE plan status
limitintegerOptional1-1000Defaults to 20

Items per page (max 1000)

offsetintegerOptional>=0Defaults to 0
Number of items to skip. Cannot be combined with after.

Response

List of plans ending soon
datalist of objects
paginationobject

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error