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

> List Superadmin consumers with manage-consumers filters, sorting, and pagination.



## OpenAPI

````yaml /api/superadmin.openapi.yaml get /manage-consumers
openapi: 3.1.0
info:
  title: YouNegotiate Superadmin API
  version: '2.0'
  description: Stateless API endpoints for the Superadmin portal.
servers:
  - url: https://api.hub.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public superadmin domain system and health endpoints.
  - name: Authentication
    description: Superadmin login, logout, password reset, and password change endpoints.
  - name: Profile
    description: Authenticated superadmin profile endpoints.
  - name: Admin Configuration
    description: Platform configuration values and feature flag controls.
  - name: MailHub Users
    description: Superadmin management for EcoMail Hub / EcoPortal users.
  - name: Super Admin Users
    description: Superadmin management for platform operations users.
  - name: Consumers
    description: Superadmin consumer account list, detail, filter, and export endpoints.
  - name: Creditors
    description: Superadmin creditor account list and account access endpoints.
  - name: Sub Accounts
    description: Superadmin sub account list and export endpoints.
  - name: Reseller Partners
    description: Superadmin reseller partner list and report-history endpoints.
  - name: Special Plan Inquiries
    description: >-
      Superadmin special membership inquiry list, detail, resolve, and close
      endpoints.
  - name: Plans
    description: >-
      Superadmin membership plan list, create, update, reorder, visibility, and
      delete endpoints.
  - name: Failed - Canceled
    description: Superadmin failed or cancelled membership list and custom email endpoints.
  - name: Merchant Requests
    description: >-
      Superadmin merchant API request list, export, email, forwarding, progress,
      and approval endpoints.
  - name: Bill Pay Donations
    description: Superadmin Bill Pay gift donation list, export, and receipt endpoints.
  - name: Export & Reporting
    description: Superadmin generated report options and CSV download endpoints.
  - name: Communications / Templates
    description: >-
      Superadmin email and SMS template management for manual communications and
      campaigns.
  - name: Communications / Groups
    description: >-
      Superadmin communication group management for dynamic consumer targeting
      and campaign selection.
  - name: Communications / Schedule Campaign
    description: >-
      Superadmin email and SMS campaign scheduling, immediate send, and delivery
      queue endpoints.
  - name: Communications / Campaign Tracker
    description: >-
      Superadmin campaign tracker snapshots, refresh actions, and consumer
      exports.
  - name: Automated Communications
    description: >-
      Superadmin automated email/SMS templates, trigger configuration, and
      delivery history endpoints.
paths:
  /manage-consumers:
    get:
      tags:
        - Consumers
      summary: List consumers
      description: >-
        List Superadmin consumers with manage-consumers filters, sorting, and
        pagination.
      operationId: superadminListConsumers
      parameters:
        - name: search
          in: query
          required: false
          description: >-
            Search by consumer identity, account number, creditor, sub account,
            phone, or email.
          schema:
            type: string
            maxLength: 255
        - name: status
          in: query
          required: false
          description: Consumer list status filter.
          schema:
            $ref: '#/components/schemas/ConsumerStatusFilter'
        - name: company
          in: query
          required: false
          description: Company ID filter.
          schema:
            type: integer
        - name: subclient
          in: query
          required: false
          description: Sub account ID filter.
          schema:
            type: integer
        - name: window
          in: query
          required: false
          description: Limit to consumers created within the last number of days.
          schema:
            type: integer
            minimum: 1
            maximum: 3650
        - name: sort
          in: query
          required: false
          description: Sort field.
          schema:
            type: string
            enum:
              - master_account_number
              - company_name
              - name
              - account_name
              - sub_name
              - placement_date
              - account_status
              - status
            default: placement_date
        - name: direction
          in: query
          required: false
          description: Sort direction.
          schema:
            type: string
            enum:
              - asc
              - desc
              - ASC
              - DESC
            default: desc
        - name: per_page
          in: query
          required: false
          description: Number of consumers per page.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
      responses:
        '200':
          description: Consumers returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperadminConsumerListResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  schemas:
    ConsumerStatusFilter:
      type: string
      enum:
        - uploaded
        - joined
        - expired_negotiation
        - payment_declined
        - cancelled_plan
        - agreed_settlement_pending_payment
        - agreed_payment_plan_pending_payment
        - hold
        - payment_setup
        - active_settlement
        - active_payment_plan
        - settled
        - dispute
        - not_paying
        - deactivated
    SuperadminConsumerListResponse:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SuperadminConsumer'
        pagination:
          $ref: '#/components/schemas/Pagination'
    SuperadminConsumer:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        company_id:
          type: integer
          nullable: true
        subclient_id:
          type: integer
          nullable: true
        consumer_profile_id:
          type: integer
          nullable: true
        reference_number:
          type: string
          nullable: true
        member_account_number:
          type: string
          nullable: true
        account_number:
          type: string
          nullable: true
        original_account_name:
          type: string
          nullable: true
        subclient_name:
          type: string
          nullable: true
        subclient_account_number:
          type: string
          nullable: true
        first_name:
          type: string
          nullable: true
        middle_name:
          type: string
          nullable: true
        last_name:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        dob:
          type: string
          format: date
          nullable: true
        last4ssn:
          type: string
          nullable: true
        mobile:
          type: string
          nullable: true
        email:
          type: string
          format: email
          nullable: true
        current_balance:
          type: string
          nullable: true
        total_balance:
          type: string
          nullable: true
        placement_date:
          type: string
          format: date
          nullable: true
        expiry_date:
          type: string
          format: date
          nullable: true
        status:
          type: string
          nullable: true
        status_label:
          type: string
          nullable: true
        account_status:
          type: string
          example: Active
        negotiation_status:
          type: string
          example: Offer Delivered
        payment_setup:
          type: boolean
        offer_accepted:
          type: boolean
        counter_offer:
          type: boolean
        company:
          $ref: '#/components/schemas/CompanySummary'
        subclient:
          $ref: '#/components/schemas/SubAccountSummary'
        consumer_profile:
          $ref: '#/components/schemas/ConsumerProfileSummary'
        reason:
          $ref: '#/components/schemas/ReasonSummary'
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    Pagination:
      type: object
      required:
        - current_page
        - from
        - last_page
        - per_page
        - to
        - total
      properties:
        current_page:
          type: integer
          example: 1
        from:
          type: integer
          nullable: true
          example: 1
        last_page:
          type: integer
          example: 1
        per_page:
          type: integer
          example: 25
        to:
          type: integer
          nullable: true
          example: 10
        total:
          type: integer
          example: 10
    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
    CompanySummary:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        company_name:
          type: string
        deleted_at:
          type: string
          format: date-time
          nullable: true
    SubAccountSummary:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        subclient_name:
          type: string
        unique_identification_number:
          type: string
          nullable: true
    ConsumerProfileSummary:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        first_name:
          type: string
          nullable: true
        last_name:
          type: string
          nullable: true
        email:
          type: string
          format: email
          nullable: true
        mobile:
          type: string
          nullable: true
    ReasonSummary:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        label:
          type: string
        display_label:
          type: string
        is_system:
          type: boolean
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      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

````