GET
List cash registers
Company space For: Manager · Permission: cash_registers.list Part of Set up cash registers.

Authorizations

Authorization
string
header
required

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

Query Parameters

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.

sort_by
string
default:id

Field the list is sorted by.

sort_order
string
default:asc

asc for ascending order, desc for descending order.

name
string

Returns only registers whose name contains this text.

session_status
string

Filter by session state: open (a register session is running) or closed.

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, name, is_seller, auto_print_invoice, linear_pos, is_locked, session_status, cash_account_id, last_closed_at, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: cashiers.

Response

200 - application/json

Resource.

data
CashRegisterResource · object[]
required

Items of this page.

meta
object
required

Pagination details.