Command Palette

Search for a command to run...

Log In

List NDIS Plan Implementations

get/public/v1/ndis-plans/{plan}/implementations

An implementation records how much of a plan budget has been contracted out, and to whom. Amounts are integer cents and may be null when no figure has been agreed.

status is one of active, completed, inactive or in-progress. frequency is one of as required (note the space), daily, weekly, fortnightly or monthly, or null.

service_provider.type is one of contact, organisation, plan-manager or provider, and is null when no service provider has been recorded. An internal implementation (is_internal) reports the provider itself. plan_budget is null when the implementation is not tied to a category budget.

  • Authorizationstringrequired

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

  • planstringrequired

    The plan UUID

  • 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 PlanImplementationResource

  • dataobject[]required
    ▶Show 9 child attributes
    • idstringrequired
      Example:9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
    • statusstringrequired
      Example:active
    • amountinteger | nullrequired
      Example:800000
    • frequencystring | nullrequired
      Example:weekly
    • descriptionstring | nullrequired
      Example:Weekly support coordination
    • implemented_atstring | nullrequired
      Example:2026-02-01T00:00:00+00:00
    • is_internalbooleanrequired
      Example:false
    • plan_budgetobject | nullrequired
      ▶Show 2 child attributes
      • idstringrequired
        Example:9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
      • support_categoryobject | nullrequired
        ▶Show 3 child attributes
        • namestringrequired
          Example:Support Coordination
        • prefixstringrequired
          Example:07
        • groupstringrequired
          Example:Capacity
    • service_providerobject | nullrequired
      ▶Show 3 child attributes
      • typestringrequired
        Example:contact
      • idstringrequired
        Example:c1o2n3t4-a5c6-47t8-9f0a-1b2c3d4e5f6a
      • namestringrequired
        Example:Jane Cooper
  • 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.

  • 401Unauthenticated
  • 403Authorization error
  • 404Not found