API Reference
/
ApiKey

Hero Health Public API (1.0.0)

Download OpenAPI description
Download API docs
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

List API Keys

Request

Retrieves a paginated list of API keys for the authenticated practice group.

Query
page_indexstring
Example: page_index=1
page_sizestring
Example: page_size=20
order_bystring
Value"createdAt"
order_descendingstring
Enumtruefalse
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/api_keys?order_by=createdAt&order_descending=true&page_index=1&page_size=20' \
  -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[].​idstring^\d+$required
data[].​keystringrequired
data[].​expire_atstring or null(date-time)required
data[].​created_atstring or null(date-time)required
data[].​partnerobjectrequired
data[].​partner.​idstring^\d+$required
data[].​partner.​namestringrequired
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Create API Key for Partner

Request

Creates a new API key for the given partner under the authenticated practice group.

Bodyapplication/jsonrequired
partner_idstring^\d+$required
curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/api_keys \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "partner_id": "string"
  }'

Responses

Ok.

Bodyapplication/json
idstring^\d+$required
keystringrequired
partnerobjectrequired
partner.​idstring^\d+$required
partner.​namestringrequired
expire_atstring or null
created_atstringrequired
Response
application/json
{
  "id": "string",
  "key": "string",
  "partner": {
    "id": "string",
    "name": "string"
  },
  "expire_at": "string",
  "created_at": "string"
}

Get an API Key

Request

Retrieves an ApiKey by its ID.

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

Responses

Ok

Bodyapplication/json
idstring^\d+$required
keystringrequired
expire_atstring or null(date-time)required
created_atstring or null(date-time)required
partnerobjectrequired
partner.​idstring^\d+$required
partner.​namestringrequired
Response
application/json
{
  "id": "string",
  "key": "string",
  "expire_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "partner": {
    "id": "string",
    "name": "string"
  }
}

Booking

Operations

Links

Operations

Utilities

Operations

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