> ## 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 account tabs

> Return My Account tabs for the authenticated consumer profile in frontend display order, including counts, active state, and `has_accounts`. The optional `status` and `search` filters match `GET /accounts` so tabs can be rendered independently from paginated account cards.



## OpenAPI

````yaml /api/consumer.openapi.yaml get /accounts/tabs
openapi: 3.1.0
info:
  title: YouNegotiate Consumer API
  version: '2.0'
  description: >-
    Stateless API endpoints for consumer portal authentication and account
    access.
servers:
  - url: https://api.consumer.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public consumer domain system and health endpoints.
  - name: Authentication
    description: >-
      Consumer identity matching, contact capture, OTP verification, token
      creation, and logout endpoints.
  - name: Profile - My ecoAddress
    description: Consumer profile tab for signed-in identity / ecoAddress context.
  - name: Profile - Communication Controls
    description: >-
      Consumer profile tab for communication permissions, email/mobile changes,
      and email/mobile verification.
  - name: Profile - My Billing Details
    description: >-
      Consumer profile tab for billing name and billing address details used for
      payment verification.
  - name: Profile - Personalize My Portal
    description: Consumer profile tab for portal colors and profile image personalization.
  - name: Accounts
    description: Consumer-owned account list and account detail endpoints.
  - name: Bill Pay Wallet
    description: >-
      Consumer Bill Pay Wallet saved payment profiles and scheduled payment
      method update endpoints.
  - name: Upcoming Payments
    description: >-
      Consumer My Bill Pay Calendar upcoming-payment rows and calendar display
      data.
  - name: Calendar Sync
    description: >-
      Consumer Google and Microsoft calendar connection, OAuth callback, and
      live-update endpoints.
  - name: Gift Registry
    description: >-
      Consumer Bill Pay Gift Registry account list, shared registry, and Helping
      Hand link endpoints.
  - name: EcoMailbox
    description: Consumer MyEcoMailBox list endpoints and unread sidebar badge state.
  - name: Notice Responses
    description: >-
      Consumer My Account notice-response wizard endpoints for sender details
      and account details.
paths:
  /accounts/tabs:
    get:
      tags:
        - Accounts
      summary: List account tabs
      description: >-
        Return My Account tabs for the authenticated consumer profile in
        frontend display order, including counts, active state, and
        `has_accounts`. The optional `status` and `search` filters match `GET
        /accounts` so tabs can be rendered independently from paginated account
        cards.
      operationId: consumerListAccountTabs
      parameters:
        - name: status
          in: query
          required: false
          description: >-
            Selected My Account tab. Empty, omitted, and unknown values
            normalize to `dashboard`. Aliases are `hold` -> `payment_plans`,
            `closed_by_yn` -> `notice_responses`, and `disputed_deactivated` ->
            `disputed_or_not_paying`.
          schema:
            type: string
            example: ready_to_negotiate
        - name: search
          in: query
          required: false
          description: >-
            Search account number, member account number, account name, company,
            subclient, and notice-response account number before calculating tab
            counts.
          schema:
            type: string
            maxLength: 255
      responses:
        '200':
          description: My Account tabs returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerAccountTabsResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '409':
          $ref: '#/components/responses/ProfileIncomplete'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  schemas:
    ConsumerAccountTabsResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: array
          description: >-
            Full My Account tab list in frontend display order, including
            zero-count tabs.
          items:
            $ref: '#/components/schemas/ConsumerAccountTab'
    ConsumerAccountTab:
      type: object
      required:
        - key
        - label
        - count
        - active
        - has_accounts
      properties:
        key:
          $ref: '#/components/schemas/ConsumerAccountTabKey'
        label:
          type: string
          example: New Offers!
        count:
          type: integer
          minimum: 0
        active:
          type: boolean
        has_accounts:
          type: boolean
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    ProfileIncompleteResponse:
      type: object
      required:
        - code
        - message
        - required_steps
      properties:
        code:
          type: string
          example: profile_incomplete
        message:
          type: string
          example: Please complete your communication profile before viewing accounts.
        required_steps:
          type: array
          items:
            type: string
          example:
            - profile_communication
    ValidationErrorResponse:
      type: object
      required:
        - message
        - errors
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    ConsumerAccountTabKey:
      type: string
      enum:
        - dashboard
        - approved_but_payment_pending
        - active_negotiation_with_counter_offer
        - ready_to_negotiate
        - active_negotiation
        - notice_responses
        - scheduled_settlements
        - payment_plans
        - settled
        - payment_declined
        - disputed_or_not_paying
        - deactivated
        - cancelled_plan
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ProfileIncomplete:
      description: >-
        The authenticated consumer profile must complete communication setup
        before My Account can be shown.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProfileIncompleteResponse'
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````