> ## 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 creditor profile notice responses

> List notice responses for a creditor profile row. If the creditor profile is linked to a company, company-sender notice responses for that company are included too.



## OpenAPI

````yaml /api/ecomailhub.openapi.yaml get /manage-creditor-profiles/{creditorProfile}/notice-responses
openapi: 3.1.0
info:
  title: YouNegotiate EcoMail Hub API
  version: '2.0'
  description: Stateless API endpoints for EcoMail Hub / EcoPortal users.
servers:
  - url: https://api.ecomailhub.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public EcoMail Hub domain system and health endpoints.
  - name: Authentication
    description: EcoMail Hub login, logout, password reset, and password change endpoints.
  - name: Profile
    description: Authenticated EcoMail Hub user profile endpoints.
  - name: Dashboard
    description: EcoMail Hub dashboard summary and notice-response bucket endpoints.
  - name: Manage Consumers
    description: >-
      EcoMail Hub consumer identity grouping and notice-response count
      endpoints.
  - name: Manage Creditors
    description: >-
      EcoMail Hub creditor profile and company-only member profile table
      endpoints.
  - name: Import Creditor Profiles
    description: EcoMail Hub creditor profile CSV import endpoints.
  - name: Manage Notice Response
    description: >-
      EcoMail Hub top-level notice-response review, reassignment, and close
      endpoints.
  - name: Manage Users
    description: EcoMail Hub user account management endpoints.
  - name: Reports
    description: EcoMail Hub one-time and scheduled CSV report endpoints.
  - name: Communications
    description: EcoMail Hub communication template editor endpoints.
paths:
  /manage-creditor-profiles/{creditorProfile}/notice-responses:
    get:
      tags:
        - Manage Creditors
      summary: List creditor profile notice responses
      description: >-
        List notice responses for a creditor profile row. If the creditor
        profile is linked to a company, company-sender notice responses for that
        company are included too.
      operationId: ecomailhubListManageCreditorProfileNoticeResponses
      parameters:
        - name: creditorProfile
          in: path
          required: true
          schema:
            type: integer
          description: Creditor profile ID from the manage creditors list.
        - name: search
          in: query
          required: false
          schema:
            type: string
            maxLength: 255
          description: >-
            Search by consumer name, notice sender name, account number, or
            notice balance.
        - name: sort
          in: query
          required: false
          schema:
            type: string
            enum:
              - response-date
              - consumer-name
              - account-number
              - notice-balance
              - response-type
              - creditor-response-status
            default: response-date
        - name: direction
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
        - 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: Creditor profile notice responses returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManageCreditorNoticeResponseListResponse'
              example:
                data:
                  - id: 456
                    consumer_id: 123
                    response_date: '2026-01-01T12:00:00.000000Z'
                    response_date_label: Jan 01, 2026
                    consumer_name: Donna Weaver
                    sender:
                      id: 22
                      sender_detail_id: 99
                      type: creditor_profile
                      name: Current Profile
                    account_number: PROFILE-100
                    notice_balance: '150.75'
                    notice_balance_label: $150.75
                    response_type:
                      value: 2
                      label: Settlement Offer
                    creditor_member_status:
                      value: yn_prospect
                      label: YN Prospect
                    creditor_response_status:
                      value: pending_delivery
                      label: Pending/Delivery
                    reason_label: null
                    notice:
                      has_notice_photo: true
                      file_url: >-
                        https://api.ecomailhub.younegotiate.com/storage/notice-responses/pending-delivery.png
                    actions:
                      can_change_creditor_profile: true
                      can_close: true
                      can_view_notice: true
                pagination:
                  current_page: 1
                  from: 1
                  last_page: 1
                  per_page: 25
                  to: 1
                  total: 1
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  schemas:
    ManageCreditorNoticeResponseListResponse:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EcomailhubCreditorNoticeResponse'
        pagination:
          $ref: '#/components/schemas/Pagination'
    EcomailhubCreditorNoticeResponse:
      type: object
      required:
        - id
        - consumer_id
        - response_date
        - response_date_label
        - consumer_name
        - sender
        - account_number
        - notice_balance
        - notice_balance_label
        - response_type
        - creditor_member_status
        - creditor_response_status
        - reason_label
        - notice
        - actions
      properties:
        id:
          type: integer
          example: 456
        consumer_id:
          type: integer
          example: 123
        response_date:
          type:
            - string
            - 'null'
          format: date-time
          example: '2026-01-01T12:00:00.000000Z'
        response_date_label:
          type:
            - string
            - 'null'
          example: Jan 01, 2026
        consumer_name:
          type: string
          example: Donna Weaver
        sender:
          oneOf:
            - $ref: '#/components/schemas/EcomailhubCreditorNoticeResponseSender'
            - type: 'null'
        account_number:
          type:
            - string
            - 'null'
          example: PROFILE-100
        notice_balance:
          type:
            - string
            - 'null'
          example: '150.75'
        notice_balance_label:
          type: string
          example: $150.75
        response_type:
          $ref: '#/components/schemas/EcomailhubCreditorNoticeResponseType'
        creditor_member_status:
          $ref: '#/components/schemas/EcomailhubCreditorMemberStatus'
        creditor_response_status:
          $ref: '#/components/schemas/EcomailhubCreditorResponseStatus'
        reason_label:
          type:
            - string
            - 'null'
          description: Present only for Closed By YN rows with a reason.
          example: Creditor Profile Not Match
        notice:
          $ref: '#/components/schemas/EcomailhubNoticeResponseNotice'
        actions:
          $ref: '#/components/schemas/EcomailhubCreditorNoticeResponseActions'
    Pagination:
      type: object
      required:
        - current_page
        - from
        - last_page
        - per_page
        - to
        - total
      properties:
        current_page:
          type: integer
          example: 1
        from:
          type:
            - integer
            - 'null'
          example: 1
        last_page:
          type: integer
          example: 1
        per_page:
          type: integer
          example: 25
        to:
          type:
            - integer
            - 'null'
          example: 1
        total:
          type: integer
          example: 1
    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
    EcomailhubCreditorNoticeResponseSender:
      type: object
      required:
        - id
        - sender_detail_id
        - type
        - name
      properties:
        id:
          type:
            - integer
            - 'null'
          example: 22
        sender_detail_id:
          type:
            - integer
            - 'null'
          example: 99
        type:
          type:
            - string
            - 'null'
          enum:
            - company
            - creditor_profile
            - null
          example: creditor_profile
        name:
          type:
            - string
            - 'null'
          example: Current Profile
    EcomailhubCreditorNoticeResponseType:
      type: object
      required:
        - value
        - label
      properties:
        value:
          type:
            - integer
            - 'null'
          enum:
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - null
          description: >-
            1 Balance Payment, 2 Settlement Offer, 3 Payment Plan Offer, 4 No
            Pay Reason, 5 Disputed, 6 Declined/Closed Negotiation.
          example: 2
        label:
          type:
            - string
            - 'null'
          example: Settlement Offer
    EcomailhubCreditorMemberStatus:
      type: object
      required:
        - value
        - label
      properties:
        value:
          type:
            - string
            - 'null'
          enum:
            - active_member
            - pending_member
            - yn_prospect
            - consumer_prospect
            - unknown
            - null
          example: yn_prospect
        label:
          type:
            - string
            - 'null'
          example: YN Prospect
    EcomailhubCreditorResponseStatus:
      type: object
      required:
        - value
        - label
      properties:
        value:
          type:
            - string
            - 'null'
          enum:
            - pending_delivery
            - delivered_pending
            - completed_added
            - closed_by_yn
            - closed_returned_to_sender
            - unknown
            - null
          example: pending_delivery
        label:
          type:
            - string
            - 'null'
          example: Pending/Delivery
    EcomailhubNoticeResponseNotice:
      type: object
      required:
        - has_notice_photo
        - file_url
      properties:
        has_notice_photo:
          type: boolean
          example: true
        file_url:
          type:
            - string
            - 'null'
          format: uri
          example: >-
            https://api.ecomailhub.younegotiate.com/storage/notice-responses/pending-delivery.png
    EcomailhubCreditorNoticeResponseActions:
      type: object
      required:
        - can_change_creditor_profile
        - can_close
        - can_view_notice
      properties:
        can_change_creditor_profile:
          type: boolean
          description: >-
            True only for pending-delivery rows whose current sender is a
            creditor profile.
          example: true
        can_close:
          type: boolean
          description: >-
            False for Completed/Added, Closed/Return to Sender, and Closed By YN
            rows.
          example: true
        can_view_notice:
          type: boolean
          example: true
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
          example:
            message: Unauthenticated.
    NotFound:
      description: Requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
          example:
            message: Not Found.
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
          example:
            message: The given data was invalid.
            errors:
              email:
                - The email field is required.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum

````