> ## 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 Consumer Profile EcoLetter history

> Return the EcoLetter History tab rows for one Consumer Profile detail page account. The account must belong to the authenticated creditor company and assigned sub-account when applicable. Rows mirror the Eco Communications table with sent date, eco type, delivered date, viewed/delivered status, and row action availability.



## OpenAPI

````yaml /api/creditor.openapi.yaml get /manage-consumers/{consumer}/e-letters
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:
  /manage-consumers/{consumer}/e-letters:
    get:
      tags:
        - Consumer Profiles
      summary: List Consumer Profile EcoLetter history
      description: >-
        Return the EcoLetter History tab rows for one Consumer Profile detail
        page account. The account must belong to the authenticated creditor
        company and assigned sub-account when applicable. Rows mirror the Eco
        Communications table with sent date, eco type, delivered date,
        viewed/delivered status, and row action availability.
      operationId: creditorListManageConsumerELetters
      parameters:
        - name: consumer
          in: path
          required: true
          description: Consumer account ID.
          schema:
            type: integer
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
      responses:
        '200':
          description: EcoLetter history returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManageConsumerELetterListResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/ActiveMembershipRequired'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  schemas:
    ManageConsumerELetterListResponse:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ManageConsumerELetter'
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
    ManageConsumerELetter:
      type: object
      additionalProperties: false
      required:
        - id
        - e_letter
        - eco_type
        - sent_at
        - delivered_at
        - communication_status
        - enabled
        - read_by_consumer
        - actions
        - action_items
        - created_at
        - updated_at
      properties:
        id:
          type: integer
        e_letter:
          type: object
          additionalProperties: false
          required:
            - id
            - type
          properties:
            id:
              type: integer
            type:
              type: object
              additionalProperties: false
              required:
                - value
                - label
              properties:
                value:
                  type: string
                  enum:
                    - normal
                    - cfpb_with_qr
                    - cfpb_without_qr
                label:
                  type: string
                  example: CFPB With QR
        eco_type:
          type: object
          additionalProperties: false
          required:
            - value
            - label
          properties:
            value:
              type: string
              enum:
                - eco_letter
                - cfpb_template
            label:
              type: string
              example: CFPB Template
        sent_at:
          type: string
          format: date-time
          nullable: true
        delivered_at:
          type: string
          format: date-time
          nullable: true
        communication_status:
          type: object
          additionalProperties: false
          required:
            - value
            - label
          properties:
            value:
              type: string
              enum:
                - delivered
                - viewed
            label:
              type: string
              example: Viewed
        enabled:
          type: boolean
        read_by_consumer:
          type: boolean
        actions:
          type: object
          additionalProperties: false
          required:
            - can_view
            - can_download_cfpb
          properties:
            can_view:
              type: boolean
            can_download_cfpb:
              type: boolean
        action_items:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - key
              - label
              - available
            properties:
              key:
                type: string
                enum:
                  - view
                  - download_cfpb_letter
              label:
                type: string
              available:
                type: boolean
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    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
  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.
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````