Command Palette

Search for a command to run...

Log In
Get help

List NDIS Plans for a Participant

get/public/v1/participants/{participant}/ndis-plans

Authorization

  • Authorizationstringrequired

    Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

  • participantstringrequired

    The participant UUID

Query parameters

  • sortstring

    Sort the results. Prefix with '-' for descending. One of: start, end.

    Example:-start
  • page[size]integer

    Number of results per page. Minimum 1, maximum 100.

    Default:25
  • page[number]integer

    The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.

    Default:1

Response

200application/json

Paginated set of NdisPlanResource

  • dataobject[]required
    ▶Show 5 child attributes
    • idstringrequired
      Example:9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
    • startstringrequired
      Example:2024-01-01T00:00:00+00:00
    • endstringrequired
      Example:2024-12-31T00:00:00+00:00
    • is_pacebooleanrequired
      Example:true
    • total_funded_supportsintegerrequired
      Example:5000000
  • metaobjectrequired
    ▶Show 5 child attributes
    • current_pageintegerrequired≥ 1
    • last_pageintegerrequired≥ 1
    • per_pageintegerrequired≥ 0

      Number of items shown per page.

    • totalintegerrequired≥ 0

      Total number of items being paginated.

    • allowed_sortsstring[]required

      The list of allowed sorts for this endpoint.

Errors

  • 401Unauthenticated
  • 403Authorization error
  • 404Not found