Returns a list of Reader
objects.
Parameters
- device_
typeenum Filters readers by device type
Possible enum valuesbbpos_
chipper2x BBPOS Chipper 2X BT reader.
bbpos_
wisepad3 BBPOS WisePad 3 reader.
bbpos_
wisepos_ e BBPOS WisePOS E reader.
mobile_
phone_ reader Tap to Pay device.
simulated_
stripe_ s700 Simulated Stripe S700 reader.
simulated_
wisepos_ e Simulated BBPOS WisePOS E reader.
stripe_
m2 Stripe M2 reader.
stripe_
s700 Stripe S700 reader.
- locationstring
A location ID to filter the response list to only readers at the specific location
- serial_
numberstring Filters readers by serial number
- statusenum
A status filter to filter readers to only offline or online readers
More parameters
- ending_
beforestring A cursor for use in pagination.
ending_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withbefore obj_
, your subsequent call can includebar ending_
in order to fetch the previous page of the list.before=obj_ bar - limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_
afterstring A cursor for use in pagination.
starting_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withafter obj_
, your subsequent call can includefoo starting_
in order to fetch the next page of the list.after=obj_ foo
Returns
A dictionary with a data
property that contains an array of up to limit
readers, starting after reader starting_
. Each entry in the array is a separate Terminal Reader
object. If no more readers are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/terminal/readers", "has_more": false, "data": [ { "id": "tmr_FDOt2wlRZEdpd7", "object": "terminal.reader", "action": null, "device_sw_version": "", "device_type": "simulated_wisepos_e", "ip_address": "0.0.0.0", "label": "Blue Rabbit", "last_seen_at": 1681320543815, "livemode": false, "location": "tml_FDOtHwxAAdIJOh", "metadata": {}, "serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7", "status": "online" } ]}