Get apitransactions

Get transactions. At least end_user_id, heron_id or request_id must be provided.

Authorizations

x-api-key · string · header · required

Query Parameters

min_amount · number

Filter by minimum amount of transaction

confidence_min · number

Filter by minimum confidence of annotation associated with transaction

Required range: 0 <= x <= 1

description_regex · string

Filter by regex matching transaction description

has_merchant · boolean | null

Filter by whether the transaction has a merchant entity associated with it

limit · integer · default: 1000

Number of transactions to return per page

Required range: 1 <= x <= 10000

max_amount · number

Filter by maximum amount of transaction

counterparty_keyword · string

Filter by keyword match on transaction counterparty; case insensitive

has_matching_transaction · boolean

Filter by whether the transaction has a matching transaction

timestamp_date_max · string<date>

Filter by latest transaction timestamp

Example:

"2020-04-27"

heron_id · string

Heron generated Id of transaction

Example:

"txn_48FzgFR5TzqpyH8TRpaXfA"

to_date · string<date>

Deprecated; see created_date_ or timestamp_date_

created_date_max · string<date>

Filter by latest transaction upload date - when Heron received the transaction

Example:

"2020-04-27"

reference_id · string

Reference Id of transaction

page · integer · default: 1

Page of transaction to return

Required range: x >= 1

end_user_id · string

End user id of transaction

created_date_min · string<date>

Filter by earliest transaction upload date - when Heron received the transaction

Example:

"2020-04-27"

description_keyword · string

Filter by keyword match on transaction description; case insensitive

confidence_max · number

Filter by maximum confidence of annotation associated with transaction

Required range: 0 <= x <= 1

account_ids · string[] | null

Account ids to include. If not provided, all accounts are included

is_recurring · boolean

Filter by whether the transaction is recurring

last_updated_max · string<date-time>

Filter for transactions whose values were last updated in Heron systems before the specified input value

Example:

"2025-11-26T17:46:38.846320"

transaction_code · string

Filter by transaction code

last_updated_min · string<date-time>

Filter for transactions whose values were last updated in Heron systems after the specified input value

Example:

"2025-11-26T17:46:38.846301"

request_id · string

Request-Id header returned in the response of POST transactions. Sending this parameter will return all transactions sent in a particular POST request, including any duplicates.

merchant_group_id · string

Filter by merchant group id

include_duplicates · boolean

Whether or not to include duplicate transactions in the response. Defaults to false unless request_id is provided, in which case it defaults to true.

category_heron_id · string[] | null

Filter by the heron_id of the category that the transaction is annotated with

Example:

"ctg_3Zakq5xEQhMqSMEBYrH7T3"

from_date · string<date>

Deprecated; see created_date_ or timestamp_date_

timestamp_date_min · string<date>

Filter by earliest transaction timestamp

Example:

"2020-04-27"

merchant_heron_id · string

Filter by merchant heron id

order_by · enum<string> · default: id_asc

What to order transactions by

Available options:

amount_asc,

amount_desc,

abs_amount_asc,

abs_amount_desc,

description_asc,

description_desc,

timestamp_asc,

timestamp_desc,

id_asc,

id_desc,

confidence_asc,

confidence_desc,

created_asc,

created_desc

Response

200

application/json

OK

_meta · object

Show child attributes

_summary · object

Show child attributes

transactions · object[]

Show child attributes