Get an Organisation

get/public/v1/organisations/{organisation}

get/public/v1/organisations/{organisation}

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

Response

{
  "data": {
    "id": "o1r2g3a4-f5a6-47b8-9c0d-1e2f3a4b5c6d",
    "name": "Astalty Therapy",
    "type": "Allied Health",
    "website": "https://astalty.com.au",
    "email": "contact@astalty.com.au",
    "phone": "0412345678",
    "abn": "12345678901",
    "ndis_registered": true,
    "registration_number": "4-ABC1234",
    "description": "Provides occupational therapy services"
  }
}

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

organisationstringrequired
The organisation UUID

Response

200application/json

OrganisationResource

dataobjectrequired
▶Show 10 child attributesHide child attributes
- idstringrequired
  Example:o1r2g3a4-f5a6-47b8-9c0d-1e2f3a4b5c6d
- namestringrequired
  Example:Astalty Therapy
- typestring | nullrequired
  Example:Allied Health
- websitestring | nullrequired
  Example:https://astalty.com.au
- emailstring | nullrequired
  Example:contact@astalty.com.au
- phonestring | nullrequired
  Example:0412345678
- abnstring | nullrequired
  Example:12345678901
- ndis_registeredboolean | nullrequired
  Example:true
- registration_numberstring | nullrequired
  Example:4-ABC1234
- descriptionstring | nullrequired
  Example:Provides occupational therapy services

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Response

Errors