Overview / System / List devices

List devices

get https://api.flactrum.com/v1/devices
Required scope devices.read
Panel screenSystem → Device fleet
Success status200
Returns A paginated list of Device objects

Parameters

NameInTypeDescription
branch_id query string —
type query string —
status query string —
silent_minutes query integer Devices that have not checked in for this many minutes. Use it to find kiosks that died overnight.
page query integer Page number.
per_page query integer Page size. Values above the maximum are rejected rather than silently clamped.
updated_since query string Only records changed at or after this instant. Use it for incremental sync.
sort query string Column to sort by. Each endpoint lists what it accepts.
direction query string Sort direction.

Response fields

FieldTypeDescription
id string —
code string Unique within the brand.
branch_id string|null —
type string —
status string —
app_version string|null —
auto_update boolean —
last_seen_at string|null —
is_locked boolean —

Examples

No recorded example yet.