> ## 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 manage consumers

> List consumers grouped by last name, date of birth, and last four SSN with pending, completed, returned, and communication profile indicators.



## OpenAPI

````yaml /api/ecomailhub.openapi.yaml get /manage-consumers
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-consumers:
    get:
      tags:
        - Manage Consumers
      summary: List manage consumers
      description: >-
        List consumers grouped by last name, date of birth, and last four SSN
        with pending, completed, returned, and communication profile indicators.
      operationId: ecomailhubListManageConsumers
      parameters:
        - name: search
          in: query
          required: false
          schema:
            type: string
            maxLength: 255
          description: Search by consumer name, YYYY-MM-DD date of birth, or last four SSN.
        - name: sort
          in: query
          required: false
          schema:
            type: string
            enum:
              - consumer-name
              - dob
              - last-four-ssn
              - pending-responses
              - completed-responses
              - returned-responses
              - communication-profile
            default: consumer-name
        - name: direction
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
            default: asc
        - 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: Grouped consumers returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManageConsumerListResponse'
              example:
                data:
                  - id: 123
                    consumer_name: Jane Weaver
                    dob: '1969-01-12'
                    last4ssn: '3332'
                    pending_responses_count: 2
                    completed_responses_count: 1
                    returned_responses_count: 0
                    communication_profile:
                      label: Both
                      email_permission: true
                      text_permission: true
                pagination:
                  current_page: 1
                  from: 1
                  last_page: 1
                  per_page: 25
                  to: 1
                  total: 1
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  schemas:
    ManageConsumerListResponse:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EcomailhubManageConsumer'
        pagination:
          $ref: '#/components/schemas/Pagination'
    EcomailhubManageConsumer:
      type: object
      required:
        - id
        - consumer_name
        - dob
        - last4ssn
        - pending_responses_count
        - completed_responses_count
        - returned_responses_count
        - communication_profile
      properties:
        id:
          type: integer
          example: 123
        consumer_name:
          type: string
          example: Jane Weaver
        dob:
          type:
            - string
            - 'null'
          format: date
          example: '1969-01-12'
        last4ssn:
          type:
            - string
            - 'null'
          example: '3332'
        pending_responses_count:
          type: integer
          example: 2
        completed_responses_count:
          type: integer
          example: 1
        returned_responses_count:
          type: integer
          example: 0
        communication_profile:
          $ref: '#/components/schemas/EcomailhubCommunicationProfile'
    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
    EcomailhubCommunicationProfile:
      type: object
      required:
        - label
        - email_permission
        - text_permission
      properties:
        label:
          type:
            - string
            - 'null'
          enum:
            - Both
            - Email
            - Text
            - null
        email_permission:
          type: boolean
        text_permission:
          type: boolean
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
          example:
            message: Unauthenticated.
    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

````