Skip to main content
GET
List terminals

Authorizations

Authorization
string
header
required

A secret key, sk_test_... or sk_live_...; a publishable key (pk_...) on the browser routes only

Query Parameters

limit
integer
default:20

How many to return, 1 to 100.

Required range: 1 <= x <= 100
Example:

20

starting_after
string<uuid>

The id of the last terminal of the previous page; the page after it is returned.

Example:

"019f2c4e-7b1a-7d3e-9a10-3c5b8e2f4a61"

label
string

Only terminals with exactly this label. Applies before starting_after.

Required string length: 1 - 120
Example:

"Truck 412"

serial_number
string

Only terminals with exactly this serial_number. Applies before starting_after.

Required string length: 1 - 64
Example:

"1853000123"

label_prefix
string

Only terminals whose label starts with this, such as the terminals of one plant when names carry it. Applies before starting_after.

Required string length: 1 - 120
Example:

"PAY1018"

checked_out
enum<string>

false lists only free terminals, true only checked-out ones. Applies before starting_after.

Available options:
true,
false
Example:

"false"

checked_out_to
string

Only terminals checked out to exactly this name. Applies before starting_after.

Required string length: 1 - 120
Example:

"Tablet TB0011"

Response

A page of terminals

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required