> ## 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 all scrapers

> Returns all scrapers with their configs and last run status.



## OpenAPI

````yaml api-reference/v1/openapi.yaml get /v1/scrapers
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/scrapers:
    get:
      tags:
        - Scrapers
      summary: List all scrapers
      description: Returns all scrapers with their configs and last run status.
      parameters:
        - schema:
            type: string
            maxLength: 20
          required: false
          name: retailerCode
          in: query
      responses:
        '200':
          description: List of scrapers
          content:
            application/json:
              schema:
                type: object
                properties:
                  scrapers:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          nullable: true
                          format: uuid
                        retailer_code:
                          type: string
                        scraper_type:
                          type: string
                        is_enabled:
                          type: boolean
                        schedule_cron:
                          type: string
                          nullable: true
                        schedule_description:
                          type: string
                          nullable: true
                        location_ids:
                          type: array
                          nullable: true
                          items:
                            type: string
                        max_workers:
                          type: number
                        batch_size:
                          type: number
                        rate_limit_delay:
                          type: number
                        alert_on_failure:
                          type: boolean
                        alert_on_error_rate:
                          type: boolean
                        error_rate_threshold:
                          type: number
                        created_at:
                          type: string
                          nullable: true
                        updated_at:
                          type: string
                          nullable: true
                        retailer:
                          nullable: true
                        currentStatus:
                          type: string
                        lastRun:
                          nullable: true
                        expectedProducts:
                          type: number
                      required:
                        - id
                        - retailer_code
                        - scraper_type
                        - is_enabled
                        - schedule_cron
                        - schedule_description
                        - location_ids
                        - max_workers
                        - batch_size
                        - rate_limit_delay
                        - alert_on_failure
                        - alert_on_error_rate
                        - error_rate_threshold
                        - created_at
                        - updated_at
                        - currentStatus
                        - expectedProducts
                  stats:
                    type: object
                    properties:
                      totalProducts:
                        type: number
                      recentUpdates:
                        type: number
                      activeScrapers:
                        type: number
                      failedRuns:
                        type: number
                    required:
                      - totalProducts
                      - recentUpdates
                      - activeScrapers
                      - failedRuns
                required:
                  - scrapers
                  - stats

````