GET
List POS sync devices
Company space For: Manager, Integrator · Permission: pos_sync_instances.list Conditions
  • The sort_by value must be one of id, name, status or created_at, and sort_order must be asc or desc.
Part of Connect offline POS devices.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sort_by
enum<string> | null

Field the list is sorted by.

Available options:
id,
name,
status,
created_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
cursor
string

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

status
string

Filter by device status: active (can sync) or revoked (cut off).

Returns only devices whose name contains this text, case-insensitively.

computer_id
string

Returns only the device registered for this computer identifier (exact match).

Response

Paginated set of PosSyncInstanceResource

data
PosSyncInstanceResource · object[]
required

POS sync devices on this page.

meta
object
required

Cursor pagination information for this page.