List transactions
Returns transactions, newest first, for a date range. Needs transactions:read; amountPaid, tipAmount,
paymentMethods and expand=payments also need payments:read. Voided transactions are left out unless you
add includeVoided=true.
bearerAuthAuthorizationBearer <api_key>branchId?stringString. One branch id from List branches. A branch outside the key's branch list returns 403 branch_forbidden; an id that is not in your company returns 404. Left out: every branch the key can read.
^[A-Za-z0-9_-]{1,128}$from?stringDate YYYY-MM-DD (a London day) or an ISO-8601 date-time with offset. Start of the range, included. Left out: 6 days before to.
to?stringDate YYYY-MM-DD (a London day, included) or an ISO-8601 date-time with offset (excluded). End of the range, at most 92 days after from. Left out: today in London.
platform?stringOne of pos, online, kiosk, unknown. Only transactions from that platform. Left out: every platform.
"pos""online""kiosk""unknown"includeVoided?booleanBoolean. true adds voided records to the list. Left out: false.
falselimit?integerInteger, 1 to 200. Records per page. Left out: 50.
1 <= value <= 20050cursor?stringString. pagination.nextCursor from the previous page, sent with the same filters. Left out: the first page.
length <= 2048expand?stringitems, payments or items,payments. Adds the line items or payments to each transaction. payments needs payments:read. Left out: neither.
"items""payments""items,payments""payments,items"include?stringComma-separated list of unit_cost, discount_code, card. Adds line item unitCost, discount.code, and the card provider and last four digits on payments (card needs payments:read). Left out: none of them.
A page of transactions
application/json- response
data*array<>pagination*meta*curl -X GET 'https://europe-west2-fyre-pos.cloudfunctions.net/publicApi/v1/transactions?branchId=YOUR_BRANCH_ID&from=2026-11-11&to=2026-11-11&platform=pos&includeVoided=false&limit=50&expand=items&include=unit_cost%2Cdiscount_code'{ "data": [ { "id": "YOUR_TRANSACTION_ID", "transactionNo": "1042", "branchId": "YOUR_BRANCH_ID", "platform": "pos", "orderType": "dine_in", "status": "completed", "isVoid": false, "isRefunded": false, "createdAt": "2026-11-11T19:42:10.000Z", "updatedAt": null, "currency": "GBP", "subTotal": 24, "totalPrice": 26.4, "refundedAmount": 0, "netTotal": 26.4, "amountPaid": 24, "tipAmount": 2.4, "paymentMethods": [ "Card" ], "discount": null, "covers": 2, "tableName": "Table 4" } ], "pagination": { "limit": 50, "hasMore": false, "nextCursor": null }, "meta": { "requestId": "6f1c2a9e-4b1d-4c4b-9d8e-0a1b2c3d4e5f", "range": { "from": "2026-11-11T00:00:00.000Z", "to": "2026-11-12T00:00:00.000Z", "fromInput": "2026-11-11", "toInput": "2026-11-11", "timezone": "Europe/London", "toIsExclusive": true }, "branchIds": "all" }}