Get support
Request a Demo
Search...
/
Get Started
Welcome
Guides
Authentication
Patient Management
Order Management
Device Management
Webhook Management
API Reference
Clinical Notes
Devices
Inventory
Items
Kits
Manufacturers
Orders
Patients
GET
List Patients
POST
Create Patient
POST
Fetch Patient By Email
GET
Fetch Patient
PUT
Update Patient
PATCH
Patch Patient
Procurements
Sites
Transfers
Webhooks
Readings - Blood Glucose
Readings - Blood Oxygen
Readings - Blood Pressure
Readings - Heart Rate
Readings - Heart Rate Variability
Readings - Peak Flow
Readings - Temperature
Readings - Weight
Tests
Resources
Models
OpenAPI Spec
Get support
Request a Demo
API Reference
Patients
List Patients
GET
https://
app.impiloplatform.com
/
api
/
v3
/
patient
Retrieves a paginated list of patients. Optional parameters allow specifying the page number and page size.
Query parameters
page
integer
Optional
The page number of the content returned.
size
integer
Optional
The size of the page of content returned.
sort
enum
Optional
The attribute to sort on.
Allowed values:
firstName
lastName
patientId
sortDescending
boolean
Optional
True if the sort direction should be descending.
id
integer
Optional
Lists only patients with the IDs provided.
siteId
integer
Optional
Lists only patients with the site IDs provided.
externalIdentifier
string
Optional
Lists only patients with the external identifiers provided.
email
string
Optional
Lists only patients with the provided email.
name
string
Optional
Lists only patients with the provided name.
archived
boolean
Optional
Lists only patients who are archived.
enrolled
boolean
Optional
Lists only patients who are enrolled.
dateOfBirthMin
string
Optional
Lists only patients born on or after the provided date.
dateOfBirthMax
string
Optional
Lists only patients born on or before the provided date.
postalCode
string
Optional
Lists only patients with the provided postal code.
country
string
Optional
Lists only patients with the provided country.
Response
This endpoint returns an object.
content
list of objects
Optional
The content of the page, consisting of a list of objects.
Show 12 properties
page
integer
Optional
The current page number. The first page has value 1.
size
integer
Optional
The current page size. Default 15, maximum 250.
total
integer
Optional
The number of objects matching the request.
first
boolean
Optional
True if this is the first page, false otherwise.
last
boolean
Optional
True if this is the last page, false otherwise.
Built with