Get an NDIS Plan

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

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

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/ndis-plans/{plan}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": {
    "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "start": "2024-01-01T00:00:00+00:00",
    "end": "2024-12-31T00:00:00+00:00",
    "is_pace": true,
    "total_funded_supports": 5000000
  }
}

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

planstringrequired
The plan UUID

Response

200application/json

NdisPlanResource

dataobjectrequired
▶Show 5 child attributesHide 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

Errors

401Unauthenticated
403Authorization error
404Not found