Patients

List Patients

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

Query parameters

pageintegerOptional
sizeintegerOptional
archivedstringOptional

Response

This endpoint returns an object
content
list of objectsOptional
The content of the page, consisting of a list of objects.
page
integerOptional
The current page number. The first page has value 1.
size
integerOptional
The current page size. Default 15, maximum 250.
total
integerOptional
The number of objects matching the request.
first
booleanOptional
True if this is the first page, false otherwise.
last
booleanOptional
True if this is the last page, false otherwise.
GET
1curl https://app.impiloplatform.com/api/v3/patient \
2 -H "Impilo-API-Key: <apiKey>"
200Retrieved
1{
2 "content": [
3 {
4 "id": 456,
5 "externalIdentifier": "external-identifier-123",
6 "firstName": "John",
7 "lastName": "Doe",
8 "dateOfBirth": "1987-09-13",
9 "email": "email@example.com",
10 "phoneNumber": "111-222-3333",
11 "archived": true,
12 "address": {
13 "lineOne": "1234 Market Street",
14 "lineTwo": "Suite 110",
15 "city": "Philadelphia",
16 "state": "PA",
17 "zipCode": "19137",
18 "country": "USA"
19 },
20 "site": {
21 "id": 1
22 },
23 "enrolled": true,
24 "sex": "unknown"
25 },
26 {
27 "id": 457,
28 "externalIdentifier": "external-identifier-123",
29 "firstName": "John",
30 "lastName": "Doe",
31 "dateOfBirth": "1987-09-13",
32 "email": "email@example.com",
33 "phoneNumber": "111-222-3333",
34 "archived": true,
35 "address": {
36 "lineOne": "1234 Market Street",
37 "lineTwo": "Suite 110",
38 "city": "Philadelphia",
39 "state": "PA",
40 "zipCode": "19137",
41 "country": "USA"
42 },
43 "site": {
44 "id": 1
45 },
46 "enrolled": true,
47 "sex": "unknown"
48 },
49 {
50 "id": 458,
51 "externalIdentifier": "external-identifier-123",
52 "firstName": "John",
53 "lastName": "Doe",
54 "dateOfBirth": "1987-09-13",
55 "email": "email@example.com",
56 "phoneNumber": "111-222-3333",
57 "archived": true,
58 "address": {
59 "lineOne": "1234 Market Street",
60 "lineTwo": "Suite 110",
61 "city": "Philadelphia",
62 "state": "PA",
63 "zipCode": "19137",
64 "country": "USA"
65 },
66 "site": {
67 "id": 1
68 },
69 "enrolled": true,
70 "sex": "unknown"
71 },
72 {
73 "id": 459,
74 "externalIdentifier": "external-identifier-123",
75 "firstName": "John",
76 "lastName": "Doe",
77 "dateOfBirth": "1987-09-13",
78 "email": "email@example.com",
79 "phoneNumber": "111-222-3333",
80 "archived": true,
81 "address": {
82 "lineOne": "1234 Market Street",
83 "lineTwo": "Suite 110",
84 "city": "Philadelphia",
85 "state": "PA",
86 "zipCode": "19137",
87 "country": "USA"
88 },
89 "site": {
90 "id": 1
91 },
92 "enrolled": true,
93 "sex": "unknown"
94 },
95 {
96 "id": 460,
97 "externalIdentifier": "external-identifier-123",
98 "firstName": "John",
99 "lastName": "Doe",
100 "dateOfBirth": "1987-09-13",
101 "email": "email@example.com",
102 "phoneNumber": "111-222-3333",
103 "archived": true,
104 "address": {
105 "lineOne": "1234 Market Street",
106 "lineTwo": "Suite 110",
107 "city": "Philadelphia",
108 "state": "PA",
109 "zipCode": "19137",
110 "country": "USA"
111 },
112 "site": {
113 "id": 1
114 },
115 "enrolled": true,
116 "sex": "unknown"
117 }
118 ],
119 "page": 1,
120 "size": 5,
121 "total": 10,
122 "first": true,
123 "last": false
124}