List participants

{
  "data": [
    {
      "id": "string",
      "first_name": "string",
      "middle_name": "string",
      "last_name": "string",
      "preferred_name": "string",
      "participant_number": "string",
      "email": "string",
      "phone_number": "string",
      "date_of_birth": "2023-01-15",
      "gender": "string",
      "pronouns": "string",
      "state": "string",
      "postcode": "string",
      "address_line_1": "string",
      "address_line_2": "string",
      "city": "string",
      "service_region_id": "string",
      "status": "Active",
      "approval_required": true,
      "onboard_date": "2023-01-15",
      "created_at": "2024-01-15T09:30:00Z",
      "date_ceased": "2023-01-15",
      "reason_for_leaving": "string",
      "exit_reason_category": {
        "id": "string",
        "name": "string"
      },
      "exit_reason_subcategory": {
        "id": "string",
        "name": "string"
      },
      "account_manager": {
        "id": "string",
        "name": "string"
      },
      "is_pace_plan": true,
      "plan_start_date": "string",
      "plan_end_date": "string"
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "has_more": true,
    "total": 1,
    "next_cursor": "string"
  }
}

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-1000Defaults to 20

Items per page (max 1000)

offsetintegerOptional>=0Defaults to 0

Number of items to skip. Cannot be combined with after.

afterstringOptional

Keyset cursor. Returns records after this id (or error_code for the error catalogue), ordered by that field ascending. Pass pagination.next_cursor from the previous page. Start a cursor walk with after=0. Cannot be combined with a non-zero offset.

Response

List of participants

datalist of objects

paginationobject

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error