List Organisations

get/public/v1/organisations

get/public/v1/organisations

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/organisations' \
  --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"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

Authorization

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

Query parameters

filter[contact_number]string
Partial match across both the phone and mobile numbers.
Example:0412
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 OrganisationResource

dataobject[]required
▶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
metaobjectrequired
▶Show 5 child attributesHide 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

Command Palette

Authorization

Query parameters

Response

Errors