> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scrip.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# List journal entries

> List journal entries (double-entry audit trail).

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.

<Note>
  For usage patterns and examples, see the [Reporting guide](/guides/reporting).
</Note>


## OpenAPI

````yaml GET /v1/journal-entries
openapi: 3.0.3
info:
  contact:
    email: support@scrip.dev
    name: Scrip Support
    url: https://scrip.dev/support
  description: >-
    Universal Incentive Infrastructure API for managing loyalty programs,
    rewards, and participant balances.


    Scrip provides a complete backend for building incentive and loyalty
    programs. Core concepts:

    - **Programs**: Containers for incentive logic (e.g., "Q1 Sales Bonus",
    "Customer Loyalty")

    - **Assets**: The currency or points being tracked (e.g., "Bonus Points",
    "Cash Rewards")

    - **Participants**: Users who earn and spend assets (identified by
    external_id)

    - **Groups**: Collections of participants for team-based incentives

    - **Rules**: Automated reward logic triggered by events

    - **Events**: Actions that trigger rule evaluation (e.g., "purchase",
    "referral")


    Response formats:

    - **Collection endpoints** return: {"data": [...], "pagination":
    {"has_more": true, "next_cursor": "..."}}

    - **Single-resource endpoints** return the resource directly

    - **Errors** return: {"code": "...", "message": "...", "details": {...}} —
    `details` is an optional object, present on input errors only
  license:
    name: Proprietary
    url: https://scrip.dev/license
  termsOfService: https://scrip.dev/terms
  title: Scrip API
  version: '1.0'
servers:
  - url: https://api.scrip.dev
security: []
tags:
  - description: >-
      Manage incentive programs. Programs are the top-level container for all
      incentive logic.
    name: Programs
  - description: >-
      Manage asset types (currencies, points). Assets define what participants
      can earn and spend.
    name: Assets
  - description: >-
      Manage participants and their balances. Participants are identified by
      external_id from your system.
    name: Participants
  - description: Manage participant groups for team-based incentives.
    name: Groups
  - description: >-
      Manage automated reward rules. Rules define conditions and actions
      triggered by events.
    name: Rules
  - description: Ingest events that trigger rule evaluation and reward distribution.
    name: Events
  - description: Transfer assets between participants.
    name: Transfers
  - description: Access ledger summaries and program activity reports.
    name: Reporting
  - description: >-
      Redeem participant balances for rewards. Supports raw amount redemptions
      and catalog item redemptions.
    name: Redemptions
  - description: >-
      Manage the reward catalog. Create and manage redeemable items with
      inventory tracking.
    name: Rewards
  - description: >-
      Schedule and manage automated event dispatching. Automations generate
      events on cron schedules, at specific times, or by evaluating participant
      state.
    name: Automations
  - description: >-
      Manage tier types and levels within programs. Tiers define status
      hierarchies that participants progress through based on qualification
      rules.
    name: Tiers
  - description: Inspect double-entry ledger records for auditing and reconciliation.
    name: Journal Entries
  - description: >-
      Manage webhook endpoints and delivery logs. Webhooks notify your
      application of real-time events via HTTP POST with HMAC-SHA256 signatures.
    name: Webhooks
paths:
  /v1/journal-entries:
    get:
      tags:
        - Journal Entries
      summary: List journal entries
      description: List journal entries (double-entry audit trail).
      operationId: listJournalEntries
      parameters:
        - description: Maximum number of results (default 50, max 200)
          in: query
          name: limit
          schema:
            default: 50
            minimum: 1
            type: integer
        - description: Pagination cursor from previous response
          in: query
          name: cursor
          schema:
            type: string
        - description: Filter by program ID
          in: query
          name: program_id
          schema:
            format: uuid
            type: string
        - description: Filter by event ID
          in: query
          name: event_id
          schema:
            format: uuid
            type: string
        - description: Filter by rule ID
          in: query
          name: rule_id
          schema:
            format: uuid
            type: string
        - description: >-
            Filter by participant ID (mutually exclusive with group_id and
            external_id)
          in: query
          name: participant_id
          schema:
            format: uuid
            type: string
        - description: >-
            Filter by group ID (mutually exclusive with participant_id and
            external_id)
          in: query
          name: group_id
          schema:
            format: uuid
            type: string
        - description: >-
            Filter by external ID (mutually exclusive with participant_id and
            group_id)
          in: query
          name: external_id
          schema:
            type: string
        - description: Filter by asset ID
          in: query
          name: asset_id
          schema:
            format: uuid
            type: string
        - description: Filter by bucket (AVAILABLE, HELD, DEFERRED)
          in: query
          name: bucket
          schema:
            type: string
        - description: Filter by created_at >= from (RFC 3339)
          in: query
          name: from
          schema:
            type: string
        - description: Filter by created_at <= to (RFC 3339)
          in: query
          name: to
          schema:
            type: string
        - description: >-
            Filter by posting amount >= min_amount (signed: positive=credit,
            negative=debit)
          in: query
          name: min_amount
          schema:
            type: string
        - description: >-
            Filter by posting amount <= max_amount (signed: positive=credit,
            negative=debit)
          in: query
          name: max_amount
          schema:
            type: string
        - description: Filter by action type (e.g. CREDIT, DEBIT, HOLD, RELEASE, FORFEIT)
          in: query
          name: action_type
          schema:
            type: string
        - description: Filter by reference_id correlation key
          in: query
          name: reference_id
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/handlers.ListResponse-handlers_JournalEntryResponse
          description: List of journal entries (postings omitted)
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrBadRequestResponse'
          description: 'Invalid query parameters (code: bad_request)'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrUnauthorizedResponse'
          description: 'Missing or invalid credentials (code: unauthorized)'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrNotFoundResponse'
          description: 'Participant or group not found for provided filter (code: not_found)'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ErrInternalResponse'
          description: 'Internal server error (code: internal_error)'
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    handlers.ListResponse-handlers_JournalEntryResponse:
      properties:
        data:
          description: Data contains the list of items
          items:
            $ref: '#/components/schemas/handlers.JournalEntryResponse'
          type: array
        pagination:
          allOf:
            - $ref: '#/components/schemas/handlers.PaginationResponse'
          description: Pagination contains cursor information for fetching more results
      type: object
    handlers.ErrBadRequestResponse:
      additionalProperties: false
      properties:
        code:
          description: Code is the machine-readable error code
          example: bad_request
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: >-
            Details provides optional structured error context (field errors,
            etc.)
        message:
          description: Message is the human-readable error description
          example: Invalid request parameters
          type: string
      type: object
    handlers.ErrUnauthorizedResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: unauthorized
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: Details provides optional structured error context
        message:
          description: Message is the human-readable error description
          example: Missing or invalid credentials
          type: string
      type: object
    handlers.ErrNotFoundResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: not_found
          type: string
        details:
          allOf:
            - $ref: '#/components/schemas/handlers.ErrorDetails'
          description: Details provides optional structured error context
        message:
          description: Message is the human-readable error description
          example: Resource not found
          type: string
      type: object
    handlers.ErrInternalResponse:
      properties:
        code:
          description: Code is the machine-readable error code
          example: internal_error
          type: string
        message:
          description: Message is the human-readable error description
          example: An internal error occurred
          type: string
      type: object
    handlers.JournalEntryResponse:
      description: A journal entry with its metadata and double-entry postings
      properties:
        action_type:
          description: Ledger action type (e.g. CREDIT, DEBIT, HOLD, RELEASE, FORFEIT)
          example: HOLD
          type: string
        created_at:
          description: When this entry was created (RFC 3339)
          example: '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        description:
          description: Human-readable explanation of the entry's purpose
          example: 'Purchase reward: 10 POINTS'
          type: string
        entry_hash:
          description: SHA-256 hash sealing this entry into the organization's hash chain
          example: b3a1d9f8c2e4a7b6d1e3f5a8c9b2d4e6f7a1b3c5d7e9f2a4b6c8d0e1f3a5b7c9
          type: string
        event_id:
          description: >-
            Event that triggered this entry (null if created via direct API
            call)
          example: 550e8400-e29b-41d4-a716-446655440002
          format: uuid
          type: string
        id:
          description: Unique identifier for this journal entry
          example: 550e8400-e29b-41d4-a716-446655440000
          format: uuid
          type: string
        postings:
          description: >-
            Double-entry postings (always sum to zero). Omitted in list
            responses.
          items:
            $ref: '#/components/schemas/handlers.PostingResponse'
          type: array
        program_id:
          description: Program this entry belongs to
          example: 550e8400-e29b-41d4-a716-446655440001
          format: uuid
          type: string
        program_name:
          description: Display name of the program
          example: Q1 Sales Bonus
          type: string
        reference_id:
          description: Correlation ID linking holds to releases
          example: auth_12345
          type: string
        rule_id:
          description: >-
            Rule that triggered this entry (null for direct API calls or
            worker-generated entries)
          example: 950e8400-e29b-41d4-a716-446655440004
          format: uuid
          type: string
      type: object
    handlers.PaginationResponse:
      properties:
        has_more:
          description: Whether more results are available beyond this page
          example: true
          type: boolean
        next_cursor:
          description: Cursor to fetch the next page. Absent when there are no more results
          example: YWJjMTIz
          type: string
      type: object
    handlers.ErrorDetails:
      description: >-
        Optional structured details about the error. Always a JSON object: a
        `fields` array for validation errors, or flat
        field/reason/expected/received properties for other input errors.
      properties:
        expected:
          description: Expected value or format (non-validation input errors)
          example: uuid
          type: string
        field:
          description: Field name that caused the error (non-validation input errors)
          example: asset_id
          type: string
        fields:
          description: >-
            Fields lists each offending input field on validation_error
            responses.
          items:
            $ref: '#/components/schemas/handlers.ErrorFieldDetail'
          type: array
        reason:
          description: Machine-readable reason code (non-validation input errors)
          example: invalid
          type: string
        received:
          description: Value that was received (non-validation input errors)
          example: not-a-uuid
          type: string
      type: object
    handlers.PostingResponse:
      description: >-
        A single line in a journal entry representing one side of a double-entry
        transaction
      properties:
        amount:
          description: Posting amount (positive = credit, negative = debit)
          example: '100.00'
          type: string
        asset_symbol:
          description: Asset being transacted
          example: POINTS
          type: string
        bucket:
          description: 'Balance bucket affected: AVAILABLE, HELD, or DEFERRED'
          example: AVAILABLE
          type: string
        created_at:
          description: When this posting was created (RFC 3339)
          example: '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        entity_type:
          description: >-
            Account owner type: PARTICIPANT, PROGRAM, GROUP, PROGRAM_TEST,
            SYSTEM_ISSUANCE, SYSTEM_BREAKAGE, or SYSTEM_REDEMPTION
          example: PARTICIPANT
          type: string
        group_id:
          description: Group that owns this account (set when entity_type is GROUP)
          example: 550e8400-e29b-41d4-a716-446655440011
          format: uuid
          type: string
        id:
          description: Unique identifier for this posting
          example: 550e8400-e29b-41d4-a716-446655440003
          format: uuid
          type: string
        participant_id:
          description: >-
            Participant who owns this account (set when entity_type is
            PARTICIPANT)
          example: 550e8400-e29b-41d4-a716-446655440010
          format: uuid
          type: string
        program_id:
          description: Program that owns this account (set when entity_type is PROGRAM)
          example: 550e8400-e29b-41d4-a716-446655440012
          format: uuid
          type: string
      type: object
    handlers.ErrorFieldDetail:
      description: >-
        A single field-level error: which input field failed, why, and (where
        known) the expected and received values.
      properties:
        expected:
          description: >-
            Expected value or format. Usually a string; for "one of" constraints
            it

            is an array of the allowed values.
        field:
          description: Field name that caused the error
          example: amount
          type: string
        message:
          description: Human-readable explanation (validation errors only)
          example: This field is required
          type: string
        reason:
          description: Machine-readable reason code
          example: required
          type: string
        received:
          description: Value that was received
          example: '-10.00'
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: API key passed in the X-API-Key header.
      in: header
      name: X-API-Key
      type: apiKey
    BearerAuth:
      description: Bearer token passed in the Authorization header (e.g. "Bearer sk_...").
      in: header
      name: Authorization
      type: apiKey

````