Home

Complete API documentation for Jump EHR. Build healthcare integrations with our REST API, webhooks, and SDKs.

Welcome to the Jump EHR API documentation. Build powerful healthcare integrations with our comprehensive REST API.

Quick Links

Quickstart - Get up and running in minutes
Authentication - Learn about API keys and scopes
API Reference - Complete endpoint documentation

Base URL

https://app.usejump.co.uk/functions/v1/api-v1

Authentication

All API requests require a Bearer token:

curl -X GET "https://app.usejump.co.uk/functions/v1/api-v1/patients" \
  -H "Authorization: Bearer pk_live_your_api_key"

Available Resources

Core Resources

Resource	Description
Patients	Patient records and demographics
Appointments	Appointment scheduling and cancellation
Consultations	Clinical consultation records and their sections
Episodes	Episodes of care and their lifecycle
Episode Events	Individual events recorded against an episode

Questionnaires

Resource	Description
Questionnaire Templates	Read questionnaire definitions
Questionnaire Responses	Create and read questionnaire submissions

Booking & Scheduling

Resource	Description
Availability	Query bookable slots and verify a slot before booking
Locations	Practice location details
Clinician Profiles	Healthcare provider profiles

Configuration

Resource	Description
Appointment Templates	Bookable appointment type configuration
Pathway Configs	Care-pathway configuration
Pathway Rules	Rules that drive pathway automation
Webhooks	Subscribe to real-time event notifications

Documents, prescriptions, problems, medications and other clinical items are exposed as sub-resources of a consultation (e.g. GET /consultations/{id}/prescriptions) rather than as top-level endpoints. See the Consultations reference for the full list of sections.

Rate Limits

1,000 requests per hour per API key
Rate limit headers included in every response:
- X-RateLimit-Limit
- X-RateLimit-Remaining

Need Help?

Email: hello@usejump.co.uk
Support: hello@usejump.co.uk

On this page