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

# Get donation history

> Retrieves paginated donation history for the authenticated user



## OpenAPI

````yaml /api-reference/oda-history-service-1.0.0.yml get /history
openapi: 3.0.1
info:
  title: oda-history-service
  version: 1.0.0
servers: []
security: []
paths:
  /history:
    get:
      summary: Get donation history
      description: Retrieves paginated donation history for the authenticated user
      operationId: getHistory
      parameters:
        - name: page
          in: query
          description: Zero-indexed page number (0-based)
          required: false
          schema:
            minimum: 0
            type: integer
            format: int32
            example: 0
        - name: size
          in: query
          description: Number of items per page
          schema:
            type: integer
            format: int32
        - name: sort
          in: query
          description: 'Sorting criteria in format: property,asc|desc'
          schema:
            type: string
        - name: systems
          in: query
          explode: false
          schema:
            type: array
            nullable: true
            items:
              type: string
        - name: events
          in: query
          explode: false
          schema:
            type: array
            nullable: true
            items:
              type: string
        - name: after
          in: query
          explode: false
          schema:
            type: string
            format: date-time
            nullable: true
        - name: before
          in: query
          explode: false
          schema:
            type: string
            format: date-time
            nullable: true
      responses:
        '200':
          description: Successfully retrieved history items
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetHistoryApi.GetHistoryResponse'
        '401':
          description: Unauthorized - user not authenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Void'
components:
  schemas:
    GetHistoryApi.GetHistoryResponse:
      type: object
      allOf:
        - $ref: '#/components/schemas/Page_HistoryItemData_'
        - $ref: '#/components/schemas/Slice_HistoryItemData_'
    Void:
      type: object
    Page_HistoryItemData_:
      type: object
      allOf:
        - $ref: '#/components/schemas/Slice_HistoryItemData_'
        - type: object
          properties:
            totalSize:
              type: integer
              format: int64
            totalPages:
              type: integer
              format: int32
    Slice_HistoryItemData_:
      required:
        - content
        - pageable
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/HistoryItemData'
        pageable:
          $ref: '#/components/schemas/Pageable'
        pageNumber:
          type: integer
          format: int32
        offset:
          type: integer
          format: int64
        size:
          type: integer
          format: int32
        empty:
          type: boolean
        numberOfElements:
          type: integer
          format: int32
    HistoryItemData:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the history item
        type:
          type: string
          description: Type of event (e.g., payment, goal)
        recipientId:
          type: string
          description: Recipient ID (streamer/creator)
        system:
          type: string
          description: Source system (e.g., donate.stream, donatello)
        originId:
          type: string
          description: Original ID from the source system
          nullable: true
        timestamp:
          type: string
          description: Timestamp of the event
          format: date-time
        nickname:
          type: string
          description: Donor's nickname
          nullable: true
        amount:
          description: Donation amount
          nullable: true
          allOf:
            - $ref: '#/components/schemas/Amount'
        message:
          type: string
          description: Message from the donor
          nullable: true
        attachments:
          type: array
          description: Attached media files
          items:
            $ref: '#/components/schemas/HistoryItemData.Attachment'
        goals:
          type: array
          description: Target goals associated with the donation
          items:
            $ref: '#/components/schemas/HistoryItemData.TargetGoal'
        reelResults:
          type: array
          description: Reel results from Instagram/Facebook
          items:
            $ref: '#/components/schemas/HistoryItemData.ReelResult'
        actions:
          type: array
          description: Action requests triggered by the donation
          items:
            $ref: '#/components/schemas/HistoryItemData.ActionRequest'
        vote:
          description: Vote associated with the donation
          nullable: true
          allOf:
            - $ref: '#/components/schemas/HistoryItemData.Vote'
        alerts:
          type: array
          description: Alerts shown to the streamer
          items:
            $ref: '#/components/schemas/HistoryItemData.Alert'
        level:
          type: integer
          format: int32
          nullable: true
        count:
          type: integer
          format: int32
          nullable: true
        levelName:
          type: string
          nullable: true
      description: History item representing a donation or event
    Pageable:
      required:
        - size
        - sort
      type: object
      allOf:
        - $ref: '#/components/schemas/Sort'
        - type: object
          properties:
            number:
              type: integer
              format: int32
            size:
              type: integer
              format: int32
            mode:
              $ref: '#/components/schemas/Pageable.Mode'
            sort:
              $ref: '#/components/schemas/Sort'
    Amount:
      required:
        - currency
        - major
        - minor
      type: object
      properties:
        minor:
          type: integer
          format: int32
        major:
          type: integer
          format: int32
        currency:
          type: string
      description: Donation amount
    HistoryItemData.Attachment:
      type: object
      properties:
        id:
          type: string
          description: Attachment ID
        url:
          type: string
          description: URL to the media
        title:
          type: string
          description: Title of the media
        thumbnail:
          type: string
          description: Thumbnail URL
      description: Media attachment
    HistoryItemData.TargetGoal:
      type: object
      properties:
        goalId:
          type: string
          description: Goal ID
        goalTitle:
          type: string
          description: Goal title
      description: Target goal
    HistoryItemData.ReelResult:
      type: object
      properties:
        title:
          type: string
          description: Title of the reel
      description: Reel result from social media
    HistoryItemData.ActionRequest:
      type: object
      properties:
        id:
          type: string
          description: Action request ID
        actionId:
          type: string
          description: Action ID
        name:
          type: string
          description: Action name
        amount:
          type: integer
          description: Amount required for the action
          format: int32
        payload:
          type: object
          additionalProperties:
            type: object
          description: Action payload data
      description: Action request triggered by donation
    HistoryItemData.Vote:
      type: object
      properties:
        id:
          type: string
          description: Vote ID
          nullable: true
        name:
          type: string
          description: Vote name
        isNew:
          type: boolean
          description: Is this a new vote?
      description: Vote voting
    HistoryItemData.Alert:
      type: object
      properties:
        id:
          type: string
          description: Alert ID
        shownAt:
          type: string
          description: When the alert was shown
          format: date-time
      description: Alert shown to streamer
    Sort:
      required:
        - orderBy
      type: object
      properties:
        orderBy:
          type: array
          items:
            $ref: '#/components/schemas/Sort.Order'
    Pageable.Mode:
      type: string
      enum:
        - CURSOR_NEXT
        - CURSOR_PREVIOUS
        - OFFSET
    Sort.Order:
      required:
        - direction
        - ignoreCase
        - property
      type: object
      properties:
        ignoreCase:
          type: boolean
        direction:
          $ref: '#/components/schemas/Sort.Order.Direction'
        property:
          type: string
        ascending:
          type: boolean
    Sort.Order.Direction:
      type: string
      enum:
        - ASC
        - DESC

````