List Patients

GET

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: firstNamelastNamepatientId

sortDescendingbooleanOptional

True if the sort direction should be descending.

idlongOptional

Lists only patients with the IDs provided.

siteIdlongOptional

Lists only patients with the site IDs provided.

externalIdentifierstringOptional

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.

dateOfBirthMinstringOptional

Lists only patients born on or after the provided date.

dateOfBirthMaxstringOptional

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

This endpoint returns an object.

contentlist of objectsOptional

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

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.

firstbooleanOptional

True if this is the first page, false otherwise.

lastbooleanOptional

True if this is the last page, false otherwise.

GET

1 curl -G https://app.impiloplatform.com/api/v3/patient \
2      -H "Impilo-API-Key: <apiKey>" \
3      -d dateOfBirthMin=2022-03-10 \
4      -d dateOfBirthMax=2022-03-10

200patientPagedResponseExample

1 {
2   "content": [
3     {
4       "firstName": "John",
5       "lastName": "Doe",
6       "id": 456,
7       "externalIdentifier": "external-identifier-123",
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         "city": "Philadelphia",
15         "state": "PA",
16         "zipCode": "19137",
17         "country": "USA",
18         "lineTwo": "Suite 110"
19       },
20       "site": {
21         "id": 1
22       },
23       "enrolled": true,
24       "sex": "unknown"
25     },
26     {
27       "firstName": "John",
28       "lastName": "Doe",
29       "id": 457,
30       "externalIdentifier": "external-identifier-123",
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         "city": "Philadelphia",
38         "state": "PA",
39         "zipCode": "19137",
40         "country": "USA",
41         "lineTwo": "Suite 110"
42       },
43       "site": {
44         "id": 1
45       },
46       "enrolled": true,
47       "sex": "unknown"
48     },
49     {
50       "firstName": "John",
51       "lastName": "Doe",
52       "id": 458,
53       "externalIdentifier": "external-identifier-123",
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         "city": "Philadelphia",
61         "state": "PA",
62         "zipCode": "19137",
63         "country": "USA",
64         "lineTwo": "Suite 110"
65       },
66       "site": {
67         "id": 1
68       },
69       "enrolled": true,
70       "sex": "unknown"
71     },
72     {
73       "firstName": "John",
74       "lastName": "Doe",
75       "id": 459,
76       "externalIdentifier": "external-identifier-123",
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         "city": "Philadelphia",
84         "state": "PA",
85         "zipCode": "19137",
86         "country": "USA",
87         "lineTwo": "Suite 110"
88       },
89       "site": {
90         "id": 1
91       },
92       "enrolled": true,
93       "sex": "unknown"
94     },
95     {
96       "firstName": "John",
97       "lastName": "Doe",
98       "id": 460,
99       "externalIdentifier": "external-identifier-123",
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         "city": "Philadelphia",
107         "state": "PA",
108         "zipCode": "19137",
109         "country": "USA",
110         "lineTwo": "Suite 110"
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 }

Built with

1	curl -G https://app.impiloplatform.com/api/v3/patient \
2	-H "Impilo-API-Key: <apiKey>" \
3	-d dateOfBirthMin=2022-03-10 \
4	-d dateOfBirthMax=2022-03-10

1	{
2	"content": [
3	{
4	"firstName": "John",
5	"lastName": "Doe",
6	"id": 456,
7	"externalIdentifier": "external-identifier-123",
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	"city": "Philadelphia",
15	"state": "PA",
16	"zipCode": "19137",
17	"country": "USA",
18	"lineTwo": "Suite 110"
19	},
20	"site": {
21	"id": 1
22	},
23	"enrolled": true,
24	"sex": "unknown"
25	},
26	{
27	"firstName": "John",
28	"lastName": "Doe",
29	"id": 457,
30	"externalIdentifier": "external-identifier-123",
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	"city": "Philadelphia",
38	"state": "PA",
39	"zipCode": "19137",
40	"country": "USA",
41	"lineTwo": "Suite 110"
42	},
43	"site": {
44	"id": 1
45	},
46	"enrolled": true,
47	"sex": "unknown"
48	},
49	{
50	"firstName": "John",
51	"lastName": "Doe",
52	"id": 458,
53	"externalIdentifier": "external-identifier-123",
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	"city": "Philadelphia",
61	"state": "PA",
62	"zipCode": "19137",
63	"country": "USA",
64	"lineTwo": "Suite 110"
65	},
66	"site": {
67	"id": 1
68	},
69	"enrolled": true,
70	"sex": "unknown"
71	},
72	{
73	"firstName": "John",
74	"lastName": "Doe",
75	"id": 459,
76	"externalIdentifier": "external-identifier-123",
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	"city": "Philadelphia",
84	"state": "PA",
85	"zipCode": "19137",
86	"country": "USA",
87	"lineTwo": "Suite 110"
88	},
89	"site": {
90	"id": 1
91	},
92	"enrolled": true,
93	"sex": "unknown"
94	},
95	{
96	"firstName": "John",
97	"lastName": "Doe",
98	"id": 460,
99	"externalIdentifier": "external-identifier-123",
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	"city": "Philadelphia",
107	"state": "PA",
108	"zipCode": "19137",
109	"country": "USA",
110	"lineTwo": "Suite 110"
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	}