Skip to main content
GET
List journal entries
Lists journal entries, which form the complete audit trail of all ledger activity. Each journal entry represents a single transaction with one or more balanced postings. Results are paginated and returned in reverse-chronological order. You can filter by program_id, participant_id, external_id, group_id, asset_id, bucket, event_id, rule_id, action_type, reference_id, time range, and amount range. Entity filters (participant_id, external_id, group_id) are mutually exclusive; include at most one per request. Amount filters apply to the signed posting value, where credits are positive and debits are negative. Use action_type to isolate specific ledger operations (for example HOLD, RELEASE, or FORFEIT). Use rule_id to isolate journal entries created by a specific rule. Use reference_id to find all journal entries associated with a specific hold, release, or settle correlation.
For usage patterns and examples, see the Reporting guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Query Parameters

limit
integer
default:50

Maximum number of results (default 50, max 200)

Required range: x >= 1
cursor
string

Pagination cursor from previous response

program_id
string<uuid>

Filter by program ID

event_id
string<uuid>

Filter by event ID

rule_id
string<uuid>

Filter by rule ID

participant_id
string<uuid>

Filter by participant ID (mutually exclusive with group_id and external_id)

group_id
string<uuid>

Filter by group ID (mutually exclusive with participant_id and external_id)

external_id
string

Filter by external ID (mutually exclusive with participant_id and group_id)

asset_id
string<uuid>

Filter by asset ID

bucket
string

Filter by bucket (AVAILABLE, HELD, DEFERRED)

from
string

Filter by created_at >= from (RFC 3339)

to
string

Filter by created_at <= to (RFC 3339)

min_amount
string

Filter by posting amount >= min_amount (signed: positive=credit, negative=debit)

max_amount
string

Filter by posting amount <= max_amount (signed: positive=credit, negative=debit)

action_type
string

Filter by action type (e.g. CREDIT, DEBIT, HOLD, RELEASE, FORFEIT)

reference_id
string

Filter by reference_id correlation key

Response

List of journal entries (postings omitted)

data
object[]

Data contains the list of items

pagination
object

Pagination contains cursor information for fetching more results