<- Devices API

Devices API

List devicesBeta

GET

 /v2/devices

List devices associated with the merchant.

Currently, only Terminal API devices are supported.

Permissions:DEVICES_READ
Try in API Explorer
Link to section

Query parameters

Example code

Link to section

cursor

string

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. See Pagination for more information.

Link to section

sort_order

string

The order in which results are listed.

  • ASC - Oldest to newest.
  • DESC - Newest to oldest (default).
Link to section

limit

integer(32-bit)

The number of results to return in a single page.

Link to section

location_id

string

If present, only returns devices at the target location.

Link to section

Response fields

Link to section

errors

Information about errors that occurred during the request.

Link to section

devices

The requested list of Device objects.

Link to section

cursor

string

The pagination cursor to be used in a subsequent request. If empty, this is the final response. See Pagination for more information.