GET
/v1/terminal/readersList Terminal readers
Lists Terminal readers and returns a paginated collection of reader objects. Use filters such as device_type, location, serial_number, or status, and use cursor parameters to navigate between result pages.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
device_typestringoptional
Filter readers by supported device type, including `bbpos_chipper2x`, `bbpos_wisepad3`, `bbpos_wisepos_e`, `mobile_phone_reader`, simulated reader types, and `stripe_m2`.
ending_beforestringoptional
A cursor containing an object ID that identifies the end of the current position when fetching the previous page.
expandarray<string>optional
Fields to expand in each response object.
limitintegeroptional
The maximum number of readers to return. Must be between 1 and 100 and defaults to 10 when omitted.
locationstringoptional
A location ID that limits results to readers assigned to that location.
serial_numberstringoptional
A reader serial number used to filter the results.
starting_afterstringoptional
A cursor containing an object ID that identifies the end of the current position when fetching the next page.
statusstringoptional
Filter readers by network status: `offline` or `online`.
200Returns a paginated list object containing reader objects in `data`, a `has_more` indicator, the list object type, and the list URL.
dataarray<Reader>required
A list of readers
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired
Error handling
limit must be between 1 and 100 and defaults to 10 when omitted. status must be offline or online, and device_type must be one of the supported reader device types. Use starting_after or ending_before with an object ID to paginate the results.