Hero Health Public API (1.0.0)

Key capabilities

• Patient messaging — Send SMS, email, and NHS App messages on behalf of a practice
• Appointment booking — List available slots, create reservations, and confirm bookings
• Patient management — Register and look up patients via PDS (Personal Demographics Service)
• Webhooks — Subscribe to events such as appointment confirmations and write-to-record outcomes
• Booking & form links — Generate sharable links for patient self-service flows
• Elements — Generate access tokens for embedding pre-built Hero UI components

Authentication

All endpoints require an x-api-key and x-practice-group-id header. API keys are scoped to specific functionality (messaging, booking, booking links). Contact Hero support to request your key.

Rate limits

Rate limits are defined in your Partner agreement. If you exceed your limit you will receive a 429 Too Many Requests response.