DevelopersReturn to site
API Reference

Clinician Profiles

Query clinician profiles with the Jump EHR API. Read-only access to clinician details, qualifications, and booking availability.

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

GET
/clinician-profiles

Authorization

BearerApiKey
AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Query Parameters

limit?integer

Maximum number of records to return (1–100, default 20)

Range1 <= value <= 100
Default20
offset?integer

Number of records to skip (default 0)

Range0 <= value
Default0
is_active?boolean
is_bookable_online?boolean
location_id?string

Filter clinicians by location

Formatuuid
search?string

Full-text search across name, display_name, and email

Response Body

application/json

curl -X GET "https://example.com/clinician-profiles"
{  "data": [    {      "id": "string",      "name": "string",      "display_name": "string",      "first_name": "string",      "last_name": "string",      "title": "string",      "role": "string",      "email": "string",      "bio": "string",      "photo_url": "string",      "qualifications": "string",      "registration_number": "string",      "professional_registration_body": "string",      "is_active": true,      "is_bookable_online": true,      "created_at": "string",      "updated_at": "string"    }  ],  "meta": {    "limit": 20,    "next_offset": 1,    "has_more": true,    "request_id": "req_abc123"  }}
GET
/clinician-profiles/{id}

Authorization

BearerApiKey
AuthorizationBearer <token>

API key with the pk_live_ prefix. pk_test_ keys are refused (403 TEST_MODE_UNAVAILABLE) until a sandbox exists.

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

curl -X GET "https://example.com/clinician-profiles/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {    "id": "string",    "name": "string",    "display_name": "string",    "first_name": "string",    "last_name": "string",    "title": "string",    "role": "string",    "email": "string",    "bio": "string",    "photo_url": "string",    "qualifications": "string",    "registration_number": "string",    "professional_registration_body": "string",    "is_active": true,    "is_bookable_online": true,    "created_at": "string",    "updated_at": "string"  },  "meta": {    "request_id": "req_abc123"  }}