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

# List pending payouts

> Returns a summary of pending payouts for all partners.



## OpenAPI

````yaml api-reference/v1/openapi.yaml get /v1/admin/partners/payouts
openapi: 3.1.0
info:
  title: Goods API
  version: 1.0.0
  description: >-
    API for Goods grocery operations - scanner app, admin dashboard, and
    customer features
  contact:
    name: Goods Team
    url: https://goods.app
servers:
  - url: http://localhost:3000
    description: Local development
  - url: https://dev.api.switchyard.run
    description: Development
  - url: https://api.switchyard.run
    description: Production
security: []
tags:
  - name: v1
    description: API v1 - unified domain-based endpoints
  - name: Scanner
    description: Scanner app endpoints for drivers and pickers
  - name: Sweeps
    description: Sweep management - retail store pickup operations
  - name: RFC Picks
    description: Ready-for-checkout picking operations
  - name: Inventory
    description: Inventory management and barcode lookup
  - name: Admin
    description: Admin dashboard endpoints
  - name: Orders
    description: Order management
  - name: Products
    description: Product catalog management
  - name: Notifications
    description: Push, email, SMS, and Slack notification management
paths:
  /v1/admin/partners/payouts:
    get:
      tags:
        - Admin - Partner Payouts
      summary: List pending payouts
      description: Returns a summary of pending payouts for all partners.
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          required: false
          name: limit
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            default: 0
          required: false
          name: offset
          in: query
        - schema:
            type: number
            nullable: true
            minimum: 0
          required: false
          name: min_amount
          in: query
      responses:
        '200':
          description: Payout summaries
          content:
            application/json:
              schema:
                type: object
                properties:
                  payouts:
                    type: array
                    items:
                      type: object
                      properties:
                        partner_brand_id:
                          type: string
                          format: uuid
                        company_name:
                          type: string
                        contact_email:
                          type: string
                        payout_method:
                          type: string
                          nullable: true
                        sale_count:
                          type: number
                        total_units:
                          type: number
                        gross_sales:
                          type: number
                        total_commission:
                          type: number
                        amount_due:
                          type: number
                        oldest_sale:
                          type: string
                          nullable: true
                          format: date-time
                        newest_sale:
                          type: string
                          nullable: true
                          format: date-time
                      required:
                        - partner_brand_id
                        - company_name
                        - contact_email
                        - payout_method
                        - sale_count
                        - total_units
                        - gross_sales
                        - total_commission
                        - amount_due
                        - oldest_sale
                        - newest_sale
                  total:
                    type: number
                  summary:
                    type: object
                    properties:
                      total_partners:
                        type: number
                      total_pending:
                        type: number
                      total_commission:
                        type: number
                    required:
                      - total_partners
                      - total_pending
                      - total_commission
                required:
                  - payouts
                  - total
                  - summary
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error

````