API Documentation is in beta. Report issues to developers@jump.health
Getting Started
Quickstart

Quickstart

Get started with the Jump EHR API in minutes.

Step 1: Get Your API Key

  1. Log in to your Jump EHR dashboard
  2. Navigate to Settings > API Keys
  3. Click Create API Key
  4. Select the scopes you need (e.g., read_patients, read_appointments)
  5. Copy your API key - you won't be able to see it again!
⚠️

Keep your API keys secure. Never expose them in client-side code or public repositories.

Step 2: Make Your First Request

Test your API key by listing patients:

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

Response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "first_name": "Sarah",
      "last_name": "Johnson",
      "date_of_birth": "1985-03-15",
      "nhs_number": "123 456 7890"
    }
  ],
  "pagination": {
    "total": 150,
    "limit": 10,
    "offset": 0,
    "has_more": true
  }
}

Step 3: Explore the API

Now that you're authenticated, explore the full API:

Code Examples

JavaScript/Node.js

const response = await fetch(
  'https://app.usejump.co.uk/functions/v1/api-v1/patients',
  {
    headers: {
      'Authorization': 'Bearer pk_live_your_api_key',
      'Content-Type': 'application/json'
    }
  }
);
 
const { data, pagination } = await response.json();
console.log(`Found ${pagination.total} patients`);

Python

import requests
 
response = requests.get(
    'https://app.usejump.co.uk/functions/v1/api-v1/patients',
    headers={
        'Authorization': 'Bearer pk_live_your_api_key',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()
print(f"Found {data['pagination']['total']} patients")

Next Steps

HomeAuthentication