Skip to content
API Reference
/
/
Upsert Admin In-Context S...

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

List Admins

Request

Retrieves a list of all admins.

Security
apiKeyAuth and practiceGroupId
Query
page_indexstring
page_sizestring
order_bystring
Value"first_name"
order_descendingboolean
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/admins?page_index=string&page_size=string&order_by=first_name&order_descending=true' \
  -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[].​first_namestringrequired
data[].​last_namestringrequired
data[].​emailstringrequired
data[].​external_prescriber_idstring or nullrequired
data[].​prescriber_detailsobject or null
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Update an Admin

Request

Updates an admin using the provided parameters.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Bodyapplication/jsonrequired
external_prescriber_idstring or nullnon-empty
prescriber_detailsobject or null
curl -i -X PATCH \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/admins/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "external_prescriber_id": "string",
    "prescriber_details": {
      "name": "string",
      "email": "user@example.com",
      "registration_code": "string"
    }
  }'

Responses

Ok

Bodyapplication/json
admin_idstringrequired
Response
application/json
{
  "admin_id": "string"
}

Upsert Admin In-Context Signature

Request

Insert or update a signature for Admin in context.

Security
apiKeyAuth and practiceGroupId
Bodyapplication/jsonrequired
signaturestringnon-emptyrequired
curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/admin/signature \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "signature": "string"
  }'

Responses

Ok

Response
No content

Upsert Admin In-Context Preferences

Request

Insert or update preferences for the given Admin.

Security
apiKeyAuth and practiceGroupId
Bodyapplication/jsonrequired
default_notification_channelstring or null
curl -i -X PATCH \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/admin/preferences \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "default_notification_channel": "string"
  }'

Responses

Ok

Response
No content

Get prescriber details

Request

Retrieves prescriber details for the admin.

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

Responses

Ok

Bodyapplication/json
idstring or null^\d+$required
emailstring(email)required
full_namestringrequired
registration_codestringrequired
Response
application/json
{
  "id": "string",
  "email": "user@example.com",
  "full_name": "string",
  "registration_code": "string"
}

List Admin Teams

Request

Retrieves a list of all admin teams.

Security
apiKeyAuth and practiceGroupId
Query
page_indexstring
page_sizestring
order_bystring
Value"admin_team_name"
order_descendingboolean
admin_idstring
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/admin_teams?page_index=string&page_size=string&order_by=admin_team_name&order_descending=true&admin_id=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[].​idstring^\d+$required
data[].​namestringrequired
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

ApiKey

Operations

Booking

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