API Reference

The Jump EHR API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON responses, and uses standard HTTP response codes and authentication.

Base URL

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

Authentication

The API uses Bearer token authentication. Include your API key in the Authorization header:

Authorization: Bearer pk_live_your_api_key

Scopes

API keys are created with specific scopes that control access to resources:

Clinical Data Scopes

Scope	Description
`read_patients`	Read patient records
`write_patients`	Create and update patients
`read_consultations`	Read consultation records
`write_consultations`	Create consultations
`read_problems`	Read patient problems
`write_problems`	Create and update problems
`read_appointments`	Read appointments
`write_appointments`	Create and update appointments
`read_documents`	Read documents
`write_documents`	Upload documents
`read_prescriptions`	Read prescriptions
`write_prescriptions`	Create prescriptions

Marketplace Scopes

Scope	Description
`read_appointment_types`	Read available services
`read_clinicians`	Read practitioner directory
`read_locations`	Read clinic locations
`read_availability`	Query available slots
`write_holds`	Create temporary slot reservations

Response Format

All successful responses follow this structure:

{
  "data": [...],
  "pagination": {
    "total": 100,
    "limit": 10,
    "offset": 0,
    "has_more": true
  }
}

Error Handling

Errors return appropriate HTTP status codes with a JSON body:

{
  "error": {
    "code": "invalid_request",
    "message": "The patient_id parameter is required"
  }
}

Status Code	Description
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid or missing API key
403	Forbidden - Insufficient scope
404	Not Found - Resource doesn't exist
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error

Interactive Explorer

Try the API directly in your browser with our API Explorer.

Rate Limits & Errors API Explorer