Kits

List Kits

GET

This endpoint returns a paginated list of all kits belonging to a customer.

You can filter by the following parameters as query params:

  • page (integer) — The page number of the content returned.
  • size (integer) — The size of the page of content returned.
  • itemId (long) — Shows only kits that contain the specified Item ID.
  • archived (bool) — Shows kits that are/aren’t archived, based on provided boolean value.

Query parameters

pageintegerOptional
sizeintegerOptional
itemIdintegerOptional
archivedbooleanOptional

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/kit \
2 -H "Impilo-API-Key: <apiKey>"
200Retrieved
1{
2 "content": [
3 {
4 "id": 123,
5 "name": "Example Kit",
6 "archived": false,
7 "kitItems": [
8 {
9 "item": {
10 "id": 1,
11 "manufacturer": {
12 "id": 2,
13 "name": "Custom Manufacturer"
14 },
15 "name": "Blood Pressure Monitor",
16 "model": "iBloodPressureMonitor123",
17 "sku": "0000001"
18 },
19 "count": 1
20 }
21 ]
22 }
23 ],
24 "page": 1,
25 "size": 15,
26 "total": 1,
27 "first": true,
28 "last": true
29}