Skip to main content
GET
Get Patients

Example Request

Example Response

All filter parameters are optional. If no filters are provided, the endpoint will return all patients, paginated according to the default values or specified page and page_size.

Authorizations

client_id
string
header
required
client_secret
string
header
required
access_token
string
header
required

Query Parameters

dob
string<date>

Filter patients by date of birth (ISO 8601 format: YYYY-MM-DD)

first_name
string

Filter patients by first name (case-insensitive, partial match)

last_name
string

Filter patients by last name (case-insensitive, partial match)

mrn
string

Filter patients by EHR MRN

ehr_id
string

Filter patients by EHR ID

phone
string

Filter patients by phone number (exact match)

status
enum<string>
default:all

Filter patients by status. Use 'active' for active patients, 'inactive' for inactive patients, or 'all' for all patients. Defaults to 'all'

Available options:
active,
inactive,
all
page
integer
default:1

The page number for pagination

page_size
integer
default:20

The number of patients per page

Required range: x <= 100
sort
enum<string>
default:-created_at

Sort order for results. Use 'created_at' for ascending (oldest first) or '-created_at' for descending (newest first). Defaults to '-created_at'

Available options:
created_at,
-created_at

Response

200 - application/json

Successful response

success
boolean
patients
object[]
pagination
object