Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Transactions API

List Transactions

Use this endpoint to retrieve the information of all Transactions created.

Note: list items do not include the operations array. Only the Retrieve a Transaction endpoint hydrates the full operations list for an individual transaction.

get/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions

Path parameters

organization_idstring uuid required

The unique identifier of the Organization associated with the Ledger.

ledger_idstring uuid required

The unique identifier of the associated Ledger.

Query parameters

limitinteger

The maximum number of items to include in the response.

metadata.messagestring

The message that will be used as metadata.

start_datestring

The beginning of the period you want to retrieve. start_date and end_date are all-or-nothing: supplying only one returns 400. If both are omitted, a default window of the last 1 month is used.

end_datestring

The end of the period you want to retrieve. start_date and end_date are all-or-nothing: supplying only one returns 400. If both are omitted, a default window of the last 1 month is used.

sort_order'asc' | 'desc'

The order used to sort the results.

cursorstring

An encoded cursor token from a previous response (next_cursor or prev_cursor) to navigate forward or backward through results.

Headers

X-Request-Idstring uuid

A unique identifier used to trace and track each request.

Authorizationstring

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Response

Indicates that the request was successful and the response contains the expected data.

next_cursorstring

Encoded cursor pointing to the next page of results.

prev_cursorstring

Encoded cursor pointing to the previous page of results.

limitinteger

The maximum number of items included in the response.