API Documentation is in beta. Report issues to developers@jump.health
API Reference
Clinicians

Clinicians

The Clinicians API provides access to healthcare provider profiles. Use this to display clinician information and filter availability.

Endpoints

MethodEndpointDescription
GET/cliniciansList all clinicians
GET/clinicians/{id}Retrieve a clinician

Required scope: read_clinicians

The Clinician Object

{
  "id": "cli_123e4567-e89b-12d3-a456-426614174000",
  "user_id": "usr_456e7890-e89b-12d3-a456-426614174111",
  "first_name": "Dr. Sarah",
  "last_name": "Johnson",
  "title": "MD, FRCP",
  "role": "General Practitioner",
  "specialties": ["Family Medicine", "Women's Health"],
  "bio": "Dr. Johnson has over 15 years of experience in family medicine...",
  "email": "sarah.johnson@clinic.com",
  "phone": "+44 20 7123 4567",
  "avatar_url": "https://example.com/avatars/sarah-johnson.jpg",
  "is_active": true,
  "created_at": "2023-01-15T00:00:00Z",
  "updated_at": "2025-01-10T14:30:00Z"
}

Attributes

FieldTypeDescription
idstringUnique identifier (UUID)
user_idstringAssociated user account
first_namestringFirst name
last_namestringLast name
titlestringProfessional title/qualifications
rolestringJob role/position
specialtiesarrayList of specialties
biostringProfessional biography
emailstringContact email
phonestringContact phone
avatar_urlstringProfile photo URL
is_activebooleanWhether currently available
created_atstringISO 8601 creation timestamp
updated_atstringISO 8601 last update timestamp

List Clinicians

GET /clinicians

Query Parameters

ParameterTypeDefaultDescription
limitinteger100Number of records (max 100)
offsetinteger0Pagination offset

Request

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

Response

{
  "data": [
    {
      "id": "cli_123e4567-e89b-12d3-a456-426614174000",
      "first_name": "Dr. Sarah",
      "last_name": "Johnson",
      "title": "MD, FRCP",
      "role": "General Practitioner",
      "specialties": ["Family Medicine", "Women's Health"],
      "avatar_url": "https://example.com/avatars/sarah-johnson.jpg",
      "is_active": true
    },
    {
      "id": "cli_234f5678-e89b-12d3-a456-426614174111",
      "first_name": "Dr. Michael",
      "last_name": "Chen",
      "title": "MD",
      "role": "Dermatologist",
      "specialties": ["Dermatology", "Skin Cancer"],
      "avatar_url": "https://example.com/avatars/michael-chen.jpg",
      "is_active": true
    }
  ],
  "pagination": {
    "total": 2,
    "limit": 100,
    "offset": 0,
    "has_more": false
  }
}

Retrieve a Clinician

GET /clinicians/{id}

Request

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

Response

{
  "data": {
    "id": "cli_123e4567-e89b-12d3-a456-426614174000",
    "user_id": "usr_456e7890-e89b-12d3-a456-426614174111",
    "first_name": "Dr. Sarah",
    "last_name": "Johnson",
    "title": "MD, FRCP",
    "role": "General Practitioner",
    "specialties": ["Family Medicine", "Women's Health"],
    "bio": "Dr. Johnson has over 15 years of experience in family medicine...",
    "email": "sarah.johnson@clinic.com",
    "phone": "+44 20 7123 4567",
    "avatar_url": "https://example.com/avatars/sarah-johnson.jpg",
    "is_active": true,
    "created_at": "2023-01-15T00:00:00Z",
    "updated_at": "2025-01-10T14:30:00Z"
  }
}

Related Resources