Clinician Profiles

The Clinician Profiles API provides read-only access to your organisation's clinician directory. Profiles include booking availability flags, qualifications, and location associations.

Endpoints

Method	Endpoint	Description
`GET`	`/clinician-profiles`	List clinician profiles
`GET`	`/clinician-profiles/{id}`	Retrieve a clinician profile

The Clinician Profile Object

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Dr Sarah Johnson",
  "display_name": "Dr S. Johnson",
  "first_name": "Sarah",
  "last_name": "Johnson",
  "title": "Dr",
  "role": "GP Partner",
  "email": "sarah.johnson@example.nhs.uk",
  "bio": "Dr Johnson has over 15 years of experience in general practice with a special interest in dermatology.",
  "photo_url": "https://example.com/photos/sarah-johnson.jpg",
  "qualifications": "MBBS, MRCGP, DRCOG",
  "registration_number": "7654321",
  "professional_registration_body": "GMC",
  "is_active": true,
  "is_bookable_online": true,
  "created_at": "2024-01-10T09:00:00Z",
  "updated_at": "2024-06-15T11:30:00Z"
}

List Clinician Profiles

GET /clinician-profiles

Query Parameters

Parameter	Type	Description
`limit`	integer	Max records to return (1–100, default 20)
`offset`	integer	Records to skip (default 0)
`is_active`	boolean	Filter by active status
`is_bookable_online`	boolean	Filter to only bookable clinicians
`location_id`	uuid	Filter clinicians by location
`search`	string	Full-text search across name, display_name, and email

Example Request

curl -H "Authorization: Bearer pk_live_xxx" \
  "https://api.jumpehr.com/api-v1/clinician-profiles?is_bookable_online=true"

Example Response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Dr Sarah Johnson",
      "display_name": "Dr S. Johnson",
      "role": "GP Partner",
      "is_active": true,
      "is_bookable_online": true,
      "..."
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "limit": 20,
    "has_more": false,
    "next_offset": null
  }
}

Retrieve a Clinician Profile

GET /clinician-profiles/{id}

Returns a single clinician profile by ID. Returns 404 if the profile does not exist or belongs to a different organisation.

Locations Appointment Templates