> ## 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 robots

> Returns all robots with optional status or active filters.



## OpenAPI

````yaml api-reference/v1/openapi.yaml get /v1/scanner/robots
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/scanner/robots:
    get:
      tags:
        - Equipment
      summary: List robots
      description: Returns all robots with optional status or active filters.
      parameters:
        - schema:
            type: string
            description: Filter by status
            example: idle
          required: false
          name: status
          in: query
        - schema:
            type: string
            description: Filter by active state (true/false)
            example: 'true'
          required: false
          name: is_active
          in: query
      responses:
        '200':
          description: List of robots with stats
          content:
            application/json:
              schema:
                type: object
                properties:
                  robots:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        display_id:
                          type: string
                        label:
                          type: string
                        name:
                          type: string
                        status:
                          type: string
                        is_active:
                          type: boolean
                        has_tote:
                          type: boolean
                        active_tote_id:
                          type: string
                          nullable: true
                      required:
                        - id
                        - display_id
                        - label
                        - name
                        - status
                        - is_active
                        - has_tote
                        - active_tote_id
                  stats:
                    type: object
                    properties:
                      total:
                        type: number
                      online:
                        type: number
                      offline:
                        type: number
                      idle:
                        type: number
                      delivering:
                        type: number
                      charging:
                        type: number
                      error:
                        type: number
                    required:
                      - total
                      - online
                      - offline
                      - idle
                      - delivering
                      - charging
                      - error
                required:
                  - robots
                  - stats

````