Clinicians
The Clinicians API provides access to healthcare provider profiles. Use this to display clinician information and filter availability.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /clinicians | List 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
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier (UUID) |
user_id | string | Associated user account |
first_name | string | First name |
last_name | string | Last name |
title | string | Professional title/qualifications |
role | string | Job role/position |
specialties | array | List of specialties |
bio | string | Professional biography |
email | string | Contact email |
phone | string | Contact phone |
avatar_url | string | Profile photo URL |
is_active | boolean | Whether currently available |
created_at | string | ISO 8601 creation timestamp |
updated_at | string | ISO 8601 last update timestamp |
List Clinicians
GET /cliniciansQuery Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | integer | 100 | Number of records (max 100) |
offset | integer | 0 | Pagination 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
- Availability - Check clinician availability
- Appointments - Book with clinicians
- Locations - Practice locations