List Transfer Requests

GET

/api/v3/transfer/transfer-request

GET

/api/v3/transfer/transfer-request

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

Try it

200listTransferRequestsExample

1 {
2   "content": [
3     {
4       "createdAt": "2023-10-01T12:00:00Z",
5       "id": 16439,
6       "currentStatus": "requested",
7       "fromCustomer": {
8         "id": 42,
9         "name": "foo"
10       },
11       "toCustomer": {
12         "id": 42,
13         "name": "foo"
14       },
15       "transferItems": [
16         {
17           "count": 42,
18           "item": {
19             "id": 1,
20             "manufacturer": {
21               "id": 1,
22               "name": "foo"
23             },
24             "model": "foo",
25             "name": "foo",
26             "orderable": true,
27             "sku": "foo"
28           },
29           "devices": [
30             {
31               "currentPatient": {
32                 "firstName": "John",
33                 "lastName": "Doe",
34                 "address": {
35                   "city": "foo",
36                   "country": "foo",
37                   "lineOne": "foo",
38                   "state": "foo",
39                   "zipCode": "foo",
40                   "lineThree": "foo",
41                   "lineTwo": "foo",
42                   "note": "foo"
43                 },
44                 "archived": true,
45                 "dateOfBirth": "1980-01-01",
46                 "email": "john.doe@example.com",
47                 "enrolled": true,
48                 "externalIdentifier": "1234abcd",
49                 "id": 1,
50                 "phoneNumber": "+1234567890",
51                 "sex": "unknown",
52                 "site": {
53                   "active": true,
54                   "address": {
55                     "city": "foo",
56                     "country": "foo",
57                     "lineOne": "foo",
58                     "state": "foo",
59                     "zipCode": "foo",
60                     "lineThree": "foo",
61                     "lineTwo": "foo",
62                     "note": "foo"
63                   },
64                   "id": 1,
65                   "name": "foo",
66                   "phoneNumber": "foo"
67                 }
68               },
69               "currentStatus": "foo",
70               "deviceEvents": [
71                 {
72                   "eventTimestamp": "foo",
73                   "type": "foo"
74                 }
75               ],
76               "deviceIdentifiers": [
77                 {
78                   "type": "foo",
79                   "value": "foo"
80                 }
81               ],
82               "disabledReadings": false,
83               "externalIdentifier": "1d23-4567-89ab-cdef",
84               "id": 1,
85               "item": {
86                 "id": 1,
87                 "manufacturer": {
88                   "id": 1,
89                   "name": "foo"
90                 },
91                 "model": "foo",
92                 "name": "foo",
93                 "orderable": true,
94                 "sku": "foo"
95               },
96               "lastHealthCheck": "2023-10-01T12:00:00Z",
97               "site": {
98                 "active": true,
99                 "address": {
100                   "city": "foo",
101                   "country": "foo",
102                   "lineOne": "foo",
103                   "state": "foo",
104                   "zipCode": "foo",
105                   "lineThree": "foo",
106                   "lineTwo": "foo",
107                   "note": "foo"
108                 },
109                 "id": 1,
110                 "name": "foo",
111                 "phoneNumber": "foo"
112               },
113               "used": true
114             }
115           ]
116         }
117       ],
118       "transferRequestEvents": [
119         {
120           "eventTimestamp": "2023-10-01T12:00:00Z",
121           "name": "requested"
122         }
123       ],
124       "transferRequestNotes": [
125         {
126           "createdAt": "2023-10-01T12:00:00Z",
127           "note": "foo"
128         }
129       ]
130     }
131   ],
132   "first": true,
133   "last": true,
134   "page": 42,
135   "size": 42,
136   "total": 42
137 }

Retrieves a paginated list of Transfer Requests from the Impilo platform.

Query parameters

pageintegerOptionalDefaults to 1

The page number of the content returned.

sizeintegerOptionalDefaults to 15

The size of the page returned. Max size is 100.

Response

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.

Headers

Query parameters

Response