Hero Health Public API (1.0.0)

Download OpenAPI description
Languages
Servers
Mock server
https://developer.herohealth.net/_mock/apis/public-api/openapi/
Staging
https://api.staging.htech.app/
Production
https://api.herohealth.net/

Practice Group

Operations

Admin

Operations

ApiKey

Operations

Booking

Operations

Utilities

Operations

Get Address Autocomplete Suggestions

Request

Retrieve a list of address suggestions based on the provided search term.

Query
searchstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/suggestions/address?search=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
dataArray of objectsrequired
data[].​addressstringrequired
data[].​idstringrequired
countnumberrequired
Response
application/json
{ "data": [ {} ], "count": 0 }

Get Address by Autocomplete Suggestion

Request

Retrieve the complete address details for selected ID

Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/suggestions/address/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
line_1stringrequired
line_2stringrequired
line_3stringrequired
countystringrequired
townstringrequired
postcodestringrequired
countrystringrequired
Response
application/json
{ "line_1": "string", "line_2": "string", "line_3": "string", "county": "string", "town": "string", "postcode": "string", "country": "string" }

Messages

Operations

Booking - HCA

Operations

Care Navigation

Operations

Consultations

Operations

Episode

Operations

Form

Operations

Form Response

Operations

Invoicing

Operations

Partner

Operations

Partners

Operations

Patients

Operations

Prescription

Operations

Subscriptions

Operations

Task

Operations

Webhooks

Operations

Prescriptions

Operations