> ## 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 Gift Registry accounts

> List the authenticated consumer's Gift Registry account rows and signed full-registry share URL. Use the returned account IDs with `POST /accounts/{consumer}/payments/helping-hand-link` when the consumer shares one account.



## OpenAPI

````yaml /api/consumer.openapi.yaml get /gift-registry/accounts
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:
  /gift-registry/accounts:
    get:
      tags:
        - Gift Registry
      summary: List Gift Registry accounts
      description: >-
        List the authenticated consumer's Gift Registry account rows and signed
        full-registry share URL. Use the returned account IDs with `POST
        /accounts/{consumer}/payments/helping-hand-link` when the consumer
        shares one account.
      operationId: consumerListGiftRegistryAccounts
      parameters:
        - $ref: '#/components/parameters/GiftRegistrySort'
        - $ref: '#/components/parameters/GiftRegistryDirection'
      responses:
        '200':
          description: Gift Registry accounts returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerGiftRegistryAccountsResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '409':
          $ref: '#/components/responses/ProfileIncomplete'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  parameters:
    GiftRegistrySort:
      name: sort
      in: query
      required: false
      description: Gift Registry table sort column.
      schema:
        type: string
        enum:
          - bill-name
          - balance
      example: bill-name
    GiftRegistryDirection:
      name: direction
      in: query
      required: false
      description: Sort direction.
      schema:
        type: string
        enum:
          - asc
          - desc
      example: asc
  schemas:
    ConsumerGiftRegistryAccountsResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          required:
            - accounts
            - total_amount
            - total_amount_label
            - share_url
          properties:
            accounts:
              type: array
              items:
                $ref: '#/components/schemas/ConsumerGiftRegistryAccount'
            total_amount:
              type: string
              description: Sum of registry account payoff or settlement amounts.
              example: '2065.00'
            total_amount_label:
              type: string
              example: $2,065.00
            share_url:
              type:
                - string
                - 'null'
              format: uri
              description: >-
                Signed frontend URL for sharing the full registry. Empty
                registries return null.
              example: >-
                https://consumer.younegotiate.com/gift-registry?c=313233&signature=signed
    ConsumerGiftRegistryAccount:
      type: object
      required:
        - id
        - account_name
        - company_name
        - type
        - type_label
        - registry_amount
        - registry_amount_label
        - payment_details
        - monthly_amount
        - monthly_amount_label
        - installment_type
        - installment_type_label
      properties:
        id:
          type: integer
          example: 123
        account_name:
          type:
            - string
            - 'null'
          example: Sadguru Shopping Center
        company_name:
          type:
            - string
            - 'null'
          example: ABC Collections
        type:
          type: string
          enum:
            - settlement
            - payment_plan
          example: settlement
        type_label:
          type: string
          enum:
            - Settlement
            - Plan
          example: Settlement
        registry_amount:
          type: string
          description: >-
            Settlement amount or full payment-plan balance used in registry
            totals.
          example: '900.00'
        registry_amount_label:
          type: string
          example: $900.00
        payment_details:
          type: string
          description: Text shown in the registry amount column.
          examples:
            - $900.00
            - $80.00/Monthly
        monthly_amount:
          type:
            - string
            - 'null'
          example: '80.00'
        monthly_amount_label:
          type:
            - string
            - 'null'
          example: $80.00
        installment_type:
          anyOf:
            - $ref: '#/components/schemas/ConsumerInstallmentType'
            - type: 'null'
        installment_type_label:
          type:
            - string
            - 'null'
          example: Monthly
    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
    ConsumerInstallmentType:
      type:
        - string
        - 'null'
      enum:
        - weekly
        - bimonthly
        - monthly
        - null
  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

````