List transactions
Cursor-paginated, scoped to the token's account and role. include=completion is rejected here — too expensive to resolve per row. Ask for it on a single record instead.
Besides the filter[<field>_<predicate>] fields, these filters take a plain value:
- filter[awaiting_my_approval] — true: only transactions waiting on the token's user's approval.
- filter[merchant_name_cont] — Merchant name contains this text, e.g. "home depot".
- filter[property_id] — Comma-separated property ids: transactions with a split on any of them.
- filter[tag_id] — Comma-separated tag ids: transactions carrying any of them.
- filter[has_work_order] — true / false: whether a split is attached to a work order.
- filter[archived] — false (default) hides archived transactions, true returns only archived ones, all returns both.
Request
- Base URL: https://api.topkey.io
- URL: https://api.topkey.io/v1/transactions
- Auth: HTTP bearer
Query parameters
Rows per page (max 100).
Opaque cursor from the previous page's meta.next_cursor.
filter[field_predicate]=value (Ransack, per-resource allowlist), and the plain-value filters listed. Unknown filters return 400. Filterable fields: amount, approval_status, authorization_status, card_last4, completion_status, created_at, direction, external_account_id, external_card_id, external_id, flagged, gl_code_id, id, integration_key, manually_completed, merchant_id, provider, status, transaction_datetime, updated_at.
Comma-separated relationships to sideload into included.
Response
A page of transactions.
Changes
No recorded changes to this operation across all 1 revision of this API.