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

# List Payees

> Get the list of payees (people or businesses that money can be sent to) belonging to one of your users.



## OpenAPI

````yaml GET /v1/platform/payees
openapi: 3.1.0
info:
  title: Finogate Platform API v1
  version: 0.1.0
servers:
  - url: https://api-sandbox.finogates.com
    description: Sandbox
  - url: https://api.finogates.com
    description: Production
security: []
tags:
  - name: auth
  - name: users
  - name: payees
  - name: verification
  - name: bank accounts
  - name: card processing
  - name: digital-assets
  - name: international
  - name: fees
  - name: onboarding
  - name: pending-applications
  - name: wallets
  - name: payments
  - name: document mailing
  - name: merchant onboarding
  - name: catalog
  - name: webhooks
  - name: screening
  - name: Platform - File Scanning
  - name: phone-numbers
  - name: sms
  - name: calls
  - name: listings
  - name: Card Transfers
  - name: embed-tokens
paths:
  /v1/platform/payees:
    get:
      tags:
        - payees
      summary: List Payees
      description: >-
        Get the list of payees (people or businesses that money can be sent to)
        belonging to one of your users.
      operationId: list_payees_v1_platform_payees_get
      parameters:
        - name: user_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            description: >-
              Optional. The unique ID of the user who owns these payees. Omit to
              list every payee in your tenant.
            examples:
              - b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4
            title: User Id
          description: >-
            Optional. The unique ID of the user who owns these payees. Omit to
            list every payee in your tenant.
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Show only payees in this state: `active` or `archived`. Omit to
              return all.
            examples:
              - active
            title: Status
          description: >-
            Show only payees in this state: `active` or `archived`. Omit to
            return all.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            description: How many payees to return per page (1 to 200).
            default: 50
            title: Limit
          description: How many payees to return per page (1 to 200).
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            description: How many payees to skip before this page starts.
            default: 0
            title: Offset
          description: How many payees to skip before this page starts.
      responses:
        '200':
          description: A page of payees.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResponse_list_PayeeRead__'
              example:
                status_code: 200
                data:
                  - id: d4e5f6a7-b8c9-0123-4567-890abcdef012
                    display_name: Acme Supplier
                    first_name: Acme
                    last_name: Supplier
                    email: payments@acme-supplier.com
                    phone: '+14155550123'
                    status: active
                    is_active: true
                    owner_user_id: b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4
                    created_at: '2025-06-10T18:10:42.000Z'
                    updated_at: '2025-06-10T18:10:42.000Z'
                  - id: a7b8c9d0-e1f2-3456-7890-abcdef012345
                    display_name: Jane Smith
                    first_name: Jane
                    last_name: Smith
                    email: jane.smith@example.com
                    status: active
                    is_active: true
                    owner_user_id: b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4
                    created_at: '2025-06-09T09:21:05.000Z'
                    updated_at: '2025-06-09T09:21:05.000Z'
                row_count: 2
                limit: 50
                current_page: 1
                total_page_number: 1
                query_generated_time: 1712847600000
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - _AuthenticatedBearer: []
components:
  schemas:
    ListResponse_list_PayeeRead__:
      properties:
        status_code:
          type: integer
          title: Status Code
          description: HTTP status code for the response.
        data:
          items:
            $ref: '#/components/schemas/PayeeRead'
          type: array
          title: Data
          description: Payload or error details.
        query_generated_time:
          type: integer
          title: Query Generated Time
          description: >-
            UTC timestamp (milliseconds since epoch) when response was
            generated.
        row_count:
          type: integer
          minimum: 0
          title: Row Count
          description: Total rows matching the request filters (not just this page).
        limit:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
          title: Limit
          description: >-
            Page size used for this response. Null for cursor-paginated
            endpoints.
        current_page:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
          title: Current Page
          description: >-
            1-indexed page number for this response. Null for cursor-paginated
            endpoints.
        total_page_number:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Total Page Number
          description: >-
            Total number of pages given the current limit. Null for
            cursor-paginated endpoints.
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
          description: Cursor for the next page, if available.
      type: object
      required:
        - status_code
        - data
        - query_generated_time
        - row_count
      title: ListResponse[list[PayeeRead]]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PayeeRead:
      properties:
        first_name:
          anyOf:
            - type: string
              maxLength: 255
            - type: 'null'
          title: First Name
        middle_name:
          anyOf:
            - type: string
              maxLength: 255
            - type: 'null'
          title: Middle Name
        last_name:
          anyOf:
            - type: string
              maxLength: 255
            - type: 'null'
          title: Last Name
        maiden_name:
          anyOf:
            - type: string
              maxLength: 255
            - type: 'null'
          title: Maiden Name
        date_of_birth:
          anyOf:
            - type: string
              maxLength: 20
            - type: 'null'
          title: Date Of Birth
        nationality:
          anyOf:
            - type: string
              maxLength: 10
            - type: 'null'
          title: Nationality
        gender:
          anyOf:
            - type: string
              maxLength: 1
            - type: 'null'
          title: Gender
        doc_number:
          anyOf:
            - type: string
              maxLength: 100
            - type: 'null'
          title: Doc Number
        doc_type:
          anyOf:
            - type: string
              maxLength: 50
            - type: 'null'
          title: Doc Type
        doc_issue_country:
          anyOf:
            - type: string
              maxLength: 10
            - type: 'null'
          title: Doc Issue Country
        doc_issue_date:
          anyOf:
            - type: string
              maxLength: 20
            - type: 'null'
          title: Doc Issue Date
        doc_due_date:
          anyOf:
            - type: string
              maxLength: 20
            - type: 'null'
          title: Doc Due Date
        doc_issuer:
          anyOf:
            - type: string
              maxLength: 255
            - type: 'null'
          title: Doc Issuer
        state:
          anyOf:
            - type: string
              maxLength: 255
            - type: 'null'
          title: State
        city:
          anyOf:
            - type: string
              maxLength: 255
            - type: 'null'
          title: City
        street:
          anyOf:
            - type: string
              maxLength: 500
            - type: 'null'
          title: Street
        postal_code:
          anyOf:
            - type: string
              maxLength: 20
            - type: 'null'
          title: Postal Code
          description: >-
            Recipient's ZIP / postal code. Required by some payout corridors
            (e.g. US) — the payout is rejected without it.
        id:
          type: string
          format: uuid
          title: Id
        display_name:
          type: string
          title: Display Name
        is_business:
          type: boolean
          title: Is Business
          default: false
        business_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Business Name
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        phone:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone
        status:
          type: string
          title: Status
        is_active:
          type: boolean
          title: Is Active
        owner_user_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Owner User Id
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
        - display_name
        - status
        - is_active
      title: PayeeRead
      description: Payee representation returned by the API.
    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
  securitySchemes:
    _AuthenticatedBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /v1/platform/auth/token

````