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

# List vendors with pagination

> Retrieve a paginated list of vendors. **Merchant scope only** - vendor tokens cannot access this endpoint.




## OpenAPI

````yaml openapi-merchant.json GET /vendors
openapi: 3.0.0
info:
  title: PuppetVendors Merchant API V2
  version: 2.0.0
  description: >-
    The endpoints reachable with a merchant API key (`mk_live_…`), minted from
    Settings → API Access in the PuppetVendors admin. A merchant key administers
    users and vendors, and renews its own token. Everything else in the V2 API,
    including orders, products, payouts, fulfillments and documents, stays on
    the v1 API token and is refused here with a 403. Keys are revealed once at
    creation; rotating one leaves the previous key working for a 24 hour grace
    window.
  contact:
    name: PuppetVendors Support
    url: https://puppetvendors.com
  license:
    name: Proprietary
servers:
  - url: https://production-api.puppetvendors.com
    description: Production
  - url: http://localhost:8082
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Auth
    description: Authentication endpoints for obtaining and refreshing API tokens
  - name: Portal - Auth
    description: Vendor portal authentication endpoints (vendor user login, token refresh)
  - name: Products
    description: Product management and synchronization
  - name: Orders
    description: Order retrieval and management
  - name: Payouts
    description: Vendor payout information
  - name: Fulfillments
    description: Order fulfillment operations
  - name: Reports
    description: Vendor sales reports and analytics
  - name: Vendors
    description: Vendor management operations
  - name: Settings
    description: Settings endpoints for vendor configuration and management
  - name: Users
    description: User account management
  - name: Shop
    description: Shop configuration and settings
  - name: Commissions
    description: Commission rate management
  - name: Integrations
    description: Vendor integration configuration endpoints
  - name: Line Items
    description: Order line item operations
paths:
  /vendors:
    get:
      tags:
        - Vendors
      summary: List vendors with pagination
      description: >
        Retrieve a paginated list of vendors. **Merchant scope only** - vendor
        tokens cannot access this endpoint.
      operationId: listVendors
      parameters:
        - in: query
          name: search
          schema:
            type: string
          description: Search in vendor name and alias
        - in: query
          name: isHidden
          schema:
            type: boolean
          description: Filter by hidden status
        - in: query
          name: commissionType
          schema:
            type: string
            enum:
              - percentage
              - flat
          description: Filter by commission type
        - in: query
          name: first
          schema:
            type: integer
            minimum: 1
            maximum: 100
          description: Number of items to return (forward pagination)
        - in: query
          name: after
          schema:
            type: string
          description: Cursor for forward pagination
        - in: query
          name: last
          schema:
            type: integer
            minimum: 1
            maximum: 100
          description: Number of items to return (backward pagination)
        - in: query
          name: before
          schema:
            type: string
          description: Cursor for backward pagination
      responses:
        '200':
          description: List of vendors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden - Merchant scope required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    PaginatedResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: object
          properties:
            items:
              type: array
              items: {}
              description: Array of items
            pageInfo:
              $ref: '#/components/schemas/PageInfo'
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          enum:
            - false
          description: Indicates the request failed
        error:
          type: object
          required:
            - message
          properties:
            message:
              type: string
              description: Human-readable error message
              example: Resource not found
            code:
              type: string
              description: >-
                Stable machine-readable error code. The frontend uses this as
                its localisation key (e.g. errors.api.<code>). Server errors
                always report INTERNAL_SERVER_ERROR.
              example: NOT_FOUND
            errorId:
              type: string
              description: >-
                Correlation id for support/log lookup. Present on opaque 5xx
                responses so a user can quote a reference for the underlying
                (server-side logged) error.
              example: err_1783365360839_j281w7b
            details:
              type: object
              description: >-
                Additional client-error context (e.g. field-level validation
                errors). Never populated for server errors.
    PageInfo:
      type: object
      required:
        - hasNextPage
        - hasPreviousPage
      properties:
        hasNextPage:
          type: boolean
          description: Whether there are more items after the current page
        hasPreviousPage:
          type: boolean
          description: Whether there are more items before the current page
        startCursor:
          type: string
          description: Cursor for the first item in the page
          nullable: true
        endCursor:
          type: string
          description: Cursor for the last item in the page
          nullable: true
        totalCount:
          type: integer
          description: Total number of items (may not always be available)
          nullable: true
  securitySchemes:
    bearerAuth:
      type: apiKey
      in: header
      name: x-access-token
      description: >-
        JWT minted from a merchant API key (`mk_live_…`) by POST /authenticate.
        Send the token value directly, with no "Bearer" prefix. Tokens last 14
        days and can be renewed at POST /refresh-token; revoking the key refuses
        the next request made with any token minted from it.

````