> ## 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 partner brands

> Returns a paginated list of partner brands with optional status filter.



## OpenAPI

````yaml api-reference/v1/openapi.yaml get /v1/admin/partners/brands
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/brands:
    get:
      tags:
        - Admin - Partners
      summary: List partner brands
      description: Returns a paginated list of partner brands with optional status filter.
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          required: false
          name: limit
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            default: 0
          required: false
          name: offset
          in: query
        - schema:
            type: string
            enum:
              - all
              - pending
              - approved
              - rejected
              - suspended
            default: all
          required: false
          name: status
          in: query
        - schema:
            type: string
          required: false
          name: search
          in: query
        - schema:
            type: string
            enum:
              - created_at
              - avg_weekly_units
              - total_revenue
            default: created_at
          required: false
          name: sort_by
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          required: false
          name: sort_dir
          in: query
      responses:
        '200':
          description: List of partner brands
          content:
            application/json:
              schema:
                type: object
                properties:
                  brands:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        brand_id:
                          type: string
                          nullable: true
                          format: uuid
                        user_id:
                          type: string
                          nullable: true
                          format: uuid
                        company_name:
                          type: string
                        contact_email:
                          type: string
                          format: email
                        contact_phone:
                          type: string
                          nullable: true
                        business_type:
                          type: string
                          nullable: true
                        company_logo_url:
                          type: string
                          nullable: true
                        website_url:
                          type: string
                          nullable: true
                        return_address_line1:
                          type: string
                          nullable: true
                        return_address_line2:
                          type: string
                          nullable: true
                        return_city:
                          type: string
                          nullable: true
                        return_state:
                          type: string
                          nullable: true
                        return_postal_code:
                          type: string
                          nullable: true
                        return_country_code:
                          type: string
                          nullable: true
                        payout_method:
                          type: string
                          nullable: true
                          enum:
                            - ach
                            - check
                            - stripe
                        approval_status:
                          type: string
                          enum:
                            - pending
                            - approved
                            - rejected
                            - suspended
                        approved_at:
                          type: string
                          nullable: true
                          format: date-time
                        rejection_reason:
                          type: string
                          nullable: true
                        default_commission_rate_ambient:
                          type: number
                          nullable: true
                        default_commission_rate_cold:
                          type: number
                          nullable: true
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                        brand:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                              format: uuid
                            name:
                              type: string
                            logo_url:
                              type: string
                              nullable: true
                          required:
                            - id
                            - name
                            - logo_url
                        product_count:
                          type: number
                        total_revenue:
                          type: number
                        avg_weekly_units:
                          type: number
                      required:
                        - id
                        - brand_id
                        - user_id
                        - company_name
                        - contact_email
                        - contact_phone
                        - business_type
                        - company_logo_url
                        - website_url
                        - return_address_line1
                        - return_address_line2
                        - return_city
                        - return_state
                        - return_postal_code
                        - return_country_code
                        - payout_method
                        - approval_status
                        - approved_at
                        - rejection_reason
                        - default_commission_rate_ambient
                        - default_commission_rate_cold
                        - created_at
                        - updated_at
                        - brand
                        - product_count
                        - total_revenue
                        - avg_weekly_units
                  total:
                    type: number
                required:
                  - brands
                  - total
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error

````