Skip to main content
GET
Get Tap Devices

Authorizations

x-client-id
string
header
required

Client ID for API authentication

x-api-key
string
header
required

API Key for API authentication

Query Parameters

limit
number
default:25

The number of tap devices to return.

Required range: 1 <= x <= 100
page
number
default:1

The page number of the tap devices to return.

Required range: x >= 1

Search by exact serial number. Must be a numeric value.

Pattern: ^\d+$
Example:

"12345"

groupId

Filter tap devices by group Id. Use "unassigned" to get devices not assigned to any group.

Available options:
unassigned
Example:

"6710f34fd5061afeec3eab58"

deviceType
enum<string>

Filter tap devices by device type.

Available options:
Lanyard,
Stand,
Bracelet,
Wristband,
Plates/Disc/Magnet/Label,
Flex,
Plate Square,
Arm Rest Rectangle,
Plates,
Disc,
Magnet,
Label
Example:

"Stand"

includeArchived
boolean

Whether to include tap devices that have been archived.

sortBy
enum<string>
default:createdAt

The field to sort the tap devices by.

Available options:
serialNumber,
createdAt
Example:

"createdAt"

sortDirection
enum<string>
default:DESC

The direction to sort the tap devices by.

Available options:
ASC,
DESC
Example:

"DESC"

Response

200 - application/json
data
object[]
required

List of tap devices.

totalCount
number
required

Total number of tap devices matching the filters.

Example:

100

Last modified on July 14, 2026