API ReferencePatients

List Patients

Retrieves a paginated list of patients. Optional parameters allow specifying the page number and page size.

Headers

Impilo-API-KeystringRequired

Query parameters

pageintegerOptional
The page number of the content returned.
sizeintegerOptional
The size of the page of content returned.
sortenumOptional
The attribute to sort on.
Allowed values:
sortDescendingbooleanOptional
True if the sort direction should be descending.
idlist of longsOptional
Lists only patients with the IDs provided.
siteIdlist of longsOptional
Lists only patients with the site IDs provided.
externalIdentifierlist of stringsOptional
Lists only patients with the external identifiers provided.
emailstringOptional
Lists only patients with the provided email.
namestringOptional
Lists only patients with the provided name.
archivedbooleanOptional
Lists only patients who are archived.
enrolledbooleanOptional
Lists only patients who are enrolled.
dateOfBirthMinstringOptionalformat: "date"
Lists only patients born on or after the provided date.
dateOfBirthMaxstringOptionalformat: "date"
Lists only patients born on or before the provided date.
postalCodestringOptional
Lists only patients with the provided postal code.
countrystringOptional
Lists only patients with the provided country.

Response

OK
contentlist of objects or null
The content of the page, consisting of a list of objects.
firstboolean or null
True if this is the first page, false otherwise.
lastboolean or null
True if this is the last page, false otherwise.
pageinteger or null
The current page number. The first page has value 1.
sizeinteger or null
The current page size. Default 15, maximum 250.
totalinteger or null
The number of objects matching the request.