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

# List report history

> List generated report history rows for the authenticated creditor user. Rows are retained for 30 days and rows attached to deleted sub accounts are hidden from the list.



## OpenAPI

````yaml /api/creditor.openapi.yaml get /reports/history
openapi: 3.1.0
info:
  title: YouNegotiate Creditor API
  version: '2.0'
  description: >-
    Stateless API endpoints for creditor portal authentication and account
    access.
servers:
  - url: https://api.creditor.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public creditor domain system and health endpoints.
  - name: Authentication
    description: Creditor registration, login, password, and email verification endpoints.
  - name: Account Settings
    description: >-
      Authenticated creditor profile, contact, operating-hours, and
      profile-image endpoints.
  - name: Account Profile
    description: >-
      Creditor onboarding profile, membership, billing, and setup status
      endpoints.
  - name: Setup Wizard
    description: >-
      Creditor setup wizard status, required-step completion, and optional-step
      completion.
  - name: Dashboard
    description: Creditor dashboard work queues and performance widgets.
  - name: Import / Export
    description: >-
      Creditor consumer import upload sessions, queued imports, history,
      downloads, and failed-row files.
  - name: Membership Settings
    description: >-
      Creditor membership dashboard, plan changes, payment method, cancellation,
      special-plan inquiry, and over-limit retry endpoints.
  - name: Merchant Account
    description: >-
      Existing merchant processor credentials, Tilled onboarding, and merchant
      application endpoints.
  - name: Header Profiles
    description: >-
      CSV header profile upload, mapping, download, and setup wizard completion
      endpoints.
  - name: SFTP Connections
    description: >-
      Creditor-managed SFTP connection profiles for imports, exports, and setup
      wizard completion.
  - name: Sub Accounts
    description: >-
      Creditor-managed sub account list, export, create, update, and delete
      endpoints.
  - name: Pay Terms Offers
    description: >-
      Creditor-managed master, sub-account, group, and group-sub-account Pay
      Terms endpoints.
  - name: Individual Custom Offers
    description: Creditor individual custom offer list endpoints.
  - name: Negotiations
    description: >-
      Creditor negotiation work queues, including notice responses and offer
      review counts.
  - name: Communications / CFPB Validation Letter
    description: >-
      CFPB Validation Letter tables, secure EcoLetter send/resend, CSV export,
      and print/download actions.
  - name: Communications / EcoLetter Template
    description: >-
      Creditor EcoLetter template management for secure eLetter communications
      and campaigns.
  - name: Communications / Groups
    description: >-
      Creditor communication group management for dynamic consumer targeting and
      campaign selection.
  - name: Communications / Schedule Campaign
    description: >-
      Creditor EcoLetter campaign scheduling, quote, immediate send, and
      delivery queue endpoints.
  - name: Communications / Campaign Tracker
    description: >-
      Creditor campaign tracker reporting, refresh, and consumer export
      endpoints.
  - name: Consumer Profiles
    description: Creditor Consumer Profiles list, filter options, and CSV export endpoints.
  - name: Terms & Conditions
    description: Creditor-managed master and sub-account Terms & Conditions templates.
  - name: About Us & Contact
    description: Creditor-managed company About Us content shown to consumers.
  - name: Logo & Links
    description: >-
      Creditor-managed master and sub-account personalized logo colors, size,
      and consumer link metadata.
  - name: Users
    description: >-
      Master creditor user management, invitations, and account deletion
      endpoints.
paths:
  /reports/history:
    get:
      tags:
        - Import / Export
      summary: List report history
      description: >-
        List generated report history rows for the authenticated creditor user.
        Rows are retained for 30 days and rows attached to deleted sub accounts
        are hidden from the list.
      operationId: creditorListReportHistories
      parameters:
        - name: sort
          in: query
          required: false
          description: Sort field.
          schema:
            type: string
            default: created-on
            enum:
              - created-on
              - name
              - account-in-scope
              - records
              - start-date
              - end-date
        - $ref: '#/components/parameters/SortDirection'
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          description: Report history rows returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportHistoryListResponse'
              example:
                data:
                  - id: 123
                    created_at: '2026-06-23T10:00:00.000000Z'
                    report_type:
                      value: active_accounts
                      label: Active Account Report
                    account_in_scope:
                      value: master
                      label: Master - All accounts
                    records: 42
                    start_date: '2026-05-01'
                    end_date: '2026-06-23'
                    status:
                      value: 1
                      label: Success
                    download_available: true
                pagination:
                  current_page: 1
                  from: 1
                  last_page: 1
                  per_page: 25
                  to: 1
                  total: 1
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/ActiveMembershipRequired'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  parameters:
    SortDirection:
      name: direction
      in: query
      required: false
      description: Sort direction.
      schema:
        type: string
        default: desc
        enum:
          - asc
          - desc
    Page:
      name: page
      in: query
      required: false
      description: Page number for paginated list responses.
      schema:
        type: integer
        minimum: 1
        default: 1
    PerPage:
      name: per_page
      in: query
      required: false
      description: Number of records per page.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 25
  schemas:
    ReportHistoryListResponse:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ReportHistory'
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
    ReportHistory:
      type: object
      required:
        - id
        - created_at
        - report_type
        - account_in_scope
        - records
        - start_date
        - end_date
        - status
        - download_available
      properties:
        id:
          type: integer
        created_at:
          type:
            - string
            - 'null'
          format: date-time
        report_type:
          type: object
          required:
            - value
            - label
          properties:
            value:
              $ref: '#/components/schemas/CreditorReportType'
            label:
              type: string
        account_in_scope:
          $ref: '#/components/schemas/ReportAccountScopeOption'
        records:
          type: integer
        start_date:
          type:
            - string
            - 'null'
          format: date
        end_date:
          type:
            - string
            - 'null'
          format: date
        status:
          type: object
          required:
            - value
            - label
          properties:
            value:
              $ref: '#/components/schemas/ReportHistoryStatus'
            label:
              type: string
        download_available:
          type: boolean
    PaginationMeta:
      type: object
      additionalProperties: true
      properties:
        current_page:
          type: integer
        from:
          type: integer
          nullable: true
        last_page:
          type: integer
        path:
          type: string
        per_page:
          type: integer
        to:
          type: integer
          nullable: true
        total:
          type: integer
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    ValidationErrorResponse:
      type: object
      required:
        - message
        - errors
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    CreditorReportType:
      type: string
      enum:
        - active_accounts
        - payment_plans
        - consumer_payments
        - cfpb_validation_demand_letters_delivery
        - compliance_deleted_accounts
        - compliance_consumer_disputes_no_pay
        - compliance_consumer_pii_opt_out
    ReportAccountScopeOption:
      type: object
      required:
        - value
        - label
      properties:
        value:
          oneOf:
            - type: string
              enum:
                - master
            - type: integer
        label:
          type: string
    ReportHistoryStatus:
      type: integer
      enum:
        - 1
        - 2
      description: 1 = Success, 2 = Failed.
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ActiveMembershipRequired:
      description: Authenticated creditor does not have an active membership.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
          example:
            message: An active membership is required.
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````