List Patients

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

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

contentlist of objectsOptional

The content of the page, consisting of a list of objects.

firstbooleanOptional

True if this is the first page, false otherwise.

lastbooleanOptional

True if this is the last page, false otherwise.

pageintegerOptional

The current page number. The first page has value 1.

sizeintegerOptional

The current page size. Default 15, maximum 250.

totalintegerOptional

The number of objects matching the request.

1	{
2	"content": [
3	{
4	"firstName": "John",
5	"lastName": "Doe",
6	"address": {
7	"city": "foo",
8	"country": "foo",
9	"lineOne": "foo",
10	"state": "foo",
11	"zipCode": "foo",
12	"lineThree": "foo",
13	"lineTwo": "foo",
14	"note": "foo"
15	},
16	"archived": true,
17	"dateOfBirth": "1980-01-01",
18	"email": "john.doe@example.com",
19	"enrolled": true,
20	"externalIdentifier": "1234abcd",
21	"id": 1,
22	"phoneNumber": "+1234567890",
23	"sex": "unknown",
24	"site": {
25	"active": true,
26	"address": {
27	"city": "foo",
28	"country": "foo",
29	"lineOne": "foo",
30	"state": "foo",
31	"zipCode": "foo",
32	"lineThree": "foo",
33	"lineTwo": "foo",
34	"note": "foo"
35	},
36	"id": 1,
37	"name": "foo",
38	"phoneNumber": "foo"
39	}
40	}
41	],
42	"first": true,
43	"last": true,
44	"page": 42,
45	"size": 42,
46	"total": 42
47	}

1	curl https://app.impiloplatform.com/api/v3/patient \
2	-H "Impilo-API-Key: <Impilo-API-Key>"

Headers

Query parameters

Response