> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paywint.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Payees

> Retrieve all payees saved under your account.

This endpoint allows you to:
- Display all payout recipients
- Review and manage beneficiary records
- Audit previously added payees



## OpenAPI

````yaml GET /api/user-api/payee/list
openapi: 3.1.0
info:
  title: paywint
  version: 0.1.0
servers:
  - url: https://api.sandbox.paywint.com
  - url: https://api.paywint.com
security: []
paths:
  /api/user-api/payee/list:
    get:
      tags:
        - Developer API Payee
      summary: List Payees
      description: |-
        Retrieve all payees saved under your account.

        This endpoint allows you to:
        - Display all payout recipients
        - Review and manage beneficiary records
        - Audit previously added payees
      operationId: list_payee_contacts_api_user_api_payee_list_get
      parameters:
        - name: X-Api-Key
          in: header
          required: true
          schema:
            type: string
            description: >-
              Your API Key (UUID format). Required to identify and authorize
              each request
            title: X-Api-Key
          description: >-
            Your API Key (UUID format). Required to identify and authorize each
            request
        - name: X-Api-Secret
          in: header
          required: true
          schema:
            type: string
            description: >-
              Secret associated with your API Key. Used for authenticating
              requests. Keep this secure.
            title: X-Api-Secret
          description: >-
            Secret associated with your API Key. Used for authenticating
            requests. Keep this secure.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ExternalListResponse_ExternalContactsRead_
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ExternalListResponse_ExternalContactsRead_:
      properties:
        success:
          type: boolean
          title: Success
          description: Indicates whether the request was processed successfully.
          default: true
          example: true
        status_code:
          anyOf:
            - type: integer
            - type: 'null'
          title: Status Code
          description: HTTP status code representing the result of the request.
          default: 200
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
          description: Short, human-readable message describing the outcome of the request.
          default: Success
        records:
          anyOf:
            - items:
                $ref: '#/components/schemas/ExternalContactsRead'
              type: array
            - type: 'null'
          title: Records
          description: List of result items returned for the current page.
        totalRecords:
          anyOf:
            - type: integer
            - type: 'null'
          title: Totalrecords
          description: >-
            Total number of matching records in the database, useful for
            paginating the full dataset.
          default: 0
        queryGeneratedTime:
          anyOf:
            - type: integer
            - type: 'null'
          title: Querygeneratedtime
          description: >-
            Unix timestamp (in seconds) indicating when this response was
            generated.
          default: 1778161546
      type: object
      title: ExternalListResponse[ExternalContactsRead]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ExternalContactsRead:
      properties:
        payee_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Payee Id
          description: Unique identifier (UUID) assigned to the payee.
          example: f47ac10b-****-****-****-0e02b2c3d479
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Full name of the payee saved by the user.
          example: John Doe
        email:
          anyOf:
            - type: string
              format: email
            - type: 'null'
          title: Email
          description: Email address of the payee
          example: john.doe@example.com
        phone_country_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone Country Code
          description: >-
            International dialing code of the payee’s phone number (e.g., +1 for
            US).
          example: '+1'
        phone:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone
          description: Payee’s local phone number, excluding country code.
          example: '1234567890'
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Timestamp indicating when the payee was added to the contact list.
          example: '2025-06-10T18:10:42.000Z'
      type: object
      title: ExternalContactsRead
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````