API ReferenceContactsParticipants

List participants

Paginated list of participants for the plan manager. Optional filters: status, state, account_manager, participant_number. 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

statusenumOptional
Filter by status
Allowed values:
stateenumOptional
Filter by state
account_managerstringOptional

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

participant_numberstringOptional
Filter by NDIS participant number
limitintegerOptional1-100Defaults to 20
Items per page
offsetintegerOptional>=0Defaults to 0
Number of items to skip

Response

List of participants
datalist of objects
paginationobject

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error