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

# Show shared Gift Registry

> Show the public signed Gift Registry payload for a consumer share link. Sorting parameters may be appended by the frontend without changing the signed link.



## OpenAPI

````yaml /api/consumer.openapi.yaml get /gift-registry
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:
    get:
      tags:
        - Gift Registry
      summary: Show shared Gift Registry
      description: >-
        Show the public signed Gift Registry payload for a consumer share link.
        Sorting parameters may be appended by the frontend without changing the
        signed link.
      operationId: consumerShowSharedGiftRegistry
      parameters:
        - name: c
          in: query
          required: true
          description: >-
            Hex-encoded consumer account ID embedded in the shared registry
            link.
          schema:
            type: string
          example: '313233'
        - name: signature
          in: query
          required: true
          description: Laravel URL signature generated by the backend.
          schema:
            type: string
          example: signed
        - $ref: '#/components/parameters/GiftRegistrySort'
        - $ref: '#/components/parameters/GiftRegistryDirection'
      responses:
        '200':
          description: Shared Gift Registry returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerSharedGiftRegistryResponse'
        '403':
          description: Invalid or expired shared registry link.
          content:
            application/json:
              schema:
                $ref: d7f83941-731e-4dcf-87d4-d5fe33ae6d95
              example:
                message: Invalid or expired link.
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
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:
    ConsumerSharedGiftRegistryResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          required:
            - profile
            - accounts
            - total_amount
            - total_amount_label
          properties:
            profile:
              $ref: '#/components/schemas/ConsumerGiftRegistryProfile'
            accounts:
              type: array
              items:
                allOf:
                  - $ref: '#/components/schemas/ConsumerGiftRegistryAccount'
                  - type: object
                    required:
                      - payment_url
                    properties:
                      payment_url:
                        type: string
                        format: uri
                        description: Signed frontend payment URL for this registry account.
                        example: >-
                          https://consumer.younegotiate.com/payment?c=313233&signature=signed
            total_amount:
              type: string
              example: '1350.00'
            total_amount_label:
              type: string
              example: $1,350.00
    ConsumerGiftRegistryProfile:
      type: object
      required:
        - first_name
        - last_name
        - image_url
      properties:
        first_name:
          type:
            - string
            - 'null'
          example: Donna
        last_name:
          type:
            - string
            - 'null'
          example: Weaver
        image_url:
          type:
            - string
            - 'null'
          format: uri
          example: >-
            https://api.consumer.younegotiate.com/storage/profile-images/thumbs/profile.webp
    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
    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:
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'

````