Skip to content
Elements
Direct booking
Quick consultation
Structured consultation
Online booking
Messaging
Inbox
Pricing
Search
Ctrl+K
API Reference
Hero Health Public API
Practice Group
Admin
ApiKey
Booking
Links
Utilities
Messages
Booking - HCA
Care Navigation
Consultations
Episode
Form
Form Response
Invoicing
Partner
Partners
Patients
Prescription
Subscriptions
Task
Webhooks
Prescriptions
/
Hero Health Public API
Hero Health Public API (1.0.0)
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
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
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
post
/v1/access_token
get
/v1/appointment_types
get
/v1/locations
get
/v1/me
patch
/v1/me
get
/v1/me/capabilities
get
/v1/me/configuration
get
/v1/network
Show 3 more...
+ Show
Admin
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/admins
patch
/v1/admins/{id}
post
/v1/admin/signature
patch
/v1/admin/preferences
get
/v1/admins/{id}/prescriber
get
/v1/admin_teams
+ Show
ApiKey
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/api_keys
post
/v1/api_keys
get
/v1/api_keys/{id}
+ Show
Booking
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/appointments/{id}
put
/v1/appointments/{id}
post
/v1/appointments
patch
/v1/appointments/{id}/book
patch
/v1/appointments/{id}/cancel
patch
/v1/appointments/{id}/reschedule
get
/v1/booking_links/{id}
get
/v1/slots/count
Show 6 more...
+ Show
Links
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
post
/v1/attachment_links
post
/v1/booking_links
patch
/v1/booking_links/{id}
post
/v1/form_links
get
/v1/links/status
post
/v1/video_links
+ Show
Utilities
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/suggestions/address
get
/v1/suggestions/address/{id}
+ Show
Messages
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
post
/v1/batch_message
get
/v1/batch_message
patch
/v1/batch_message/{id}/send
get
/v1/batch_message/{id}
get
/v1/batch_message/{id}/recipients
get
/v1/batch_message/{id}/messages
get
/v1/messages/{id}
post
/v1/messages/send
Show 6 more...
+ Show
Booking - HCA
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/booking-hca/consultants
get
/v1/booking-hca/consultants/{gmc_number}
get
/v1/booking-hca/consultants/{crm_id}/availability
post
/v1/booking-hca/appointments
+ Show
Care Navigation
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/care-nav/pathways
get
/v1/care-nav/pathways/{id}
get
/v1/care-nav/submissions/{id}
get
/v1/care-nav/submissions
post
/v1/care-nav/submission
get
/v1/care-nav/submission-types
get
/v1/care-nav/submission-types/{id}
+ Show
Consultations
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/consultations/{id}
patch
/v1/consultations/{id}
delete
/v1/consultations/{id}
get
/v1/consultations
post
/v1/consultations
post
/v1/consultations/{id}/finalise
+ Show
Episode
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/episodes/count
get
/v1/episodes
get
/v1/episodes/{id}
patch
/v1/episodes/{id}
+ Show
Form
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/forms
get
/v1/forms/{id}
post
/v1/forms/{id}/response
post
/v1/forms/response/{id}
+ Show
Form Response
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/form_response/{id}
get
/v1/form_submission_response/{id}
get
/v2/form_responses
+ Show
Invoicing
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/invoicing/coupons
get
/v1/invoicing/customers
post
/v1/invoicing/customers
get
/v1/invoicing/customers/default
post
/v1/invoicing/membership-policies
get
/v1/invoicing/membership-schemes
get
/v1/invoicing/products
+ Show
Partner
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/partners
+ Show
Partners
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/partners/heidi/token
+ Show
Patients
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/patients/{id}/ehr/candidates
post
/v1/patients/{id}/ehr/connect
post
/v1/patients/{id}/merge/preview
post
/v1/patients/{id}/merge
get
/v1/patients/{id}
get
/v1/patients/{id}/attachments
get
/v1/patients
post
/v1/patients/register_pds
Show 5 more...
+ Show
Prescription
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/prescriber/{id}/pharmacies
post
/v1/pharmacies
post
/v1/prescriptions
get
/v1/prescriptions/{id}
post
/v2/prescriptions
get
/v1/prescriber/{id}
Deprecated
+ Show
Subscriptions
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v1/subscriptions
get
/v1/subscribers
+ Show
Task
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
patch
/v1/tasks/{id}
Deprecated
get
/v2/tasks/{id}
Deprecated
get
/v2/tasks
Deprecated
+ Show
Webhooks
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
post
/v1/webhooks
get
/v1/webhooks
delete
/v1/webhooks/{id}
get
/v1/webhooks/{id}/executions
+ Show
Prescriptions
Copy
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Operations
get
/v2/prescriptions
+ Show