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

> Get a list of sweeps with optional filtering by status



## OpenAPI

````yaml api-reference/v1/openapi.yaml get /v1/sweeps
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/sweeps:
    get:
      tags:
        - Sweeps
      summary: List sweeps
      description: Get a list of sweeps with optional filtering by status
      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:
              - my
              - available
              - completed
              - all
              - ready_to_receive
              - receiving_upcoming
              - received
            default: my
          required: false
          name: filter
          in: query
      responses:
        '200':
          description: List of sweeps
          content:
            application/json:
              schema:
                type: object
                properties:
                  sweeps:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        taxonomy_id:
                          type: string
                          nullable: true
                        retailer_location_id:
                          type: string
                        sweep_date:
                          type: string
                        sweep_number:
                          type: string
                          nullable: true
                        sweep_type:
                          type: string
                        scheduled_start_time:
                          type: string
                        scheduled_end_time:
                          type: string
                          nullable: true
                        actual_start_time:
                          type: string
                          nullable: true
                        actual_end_time:
                          type: string
                          nullable: true
                        status:
                          type: string
                          enum:
                            - scheduled
                            - ready
                            - in_progress
                            - checkout
                            - completed
                            - delivered
                            - decanted
                            - cancelled
                        driver_id:
                          type: string
                          nullable: true
                          format: uuid
                        total_items:
                          type: number
                        total_load:
                          type: number
                          nullable: true
                        is_locked:
                          type: boolean
                        delivery_fee:
                          type: number
                          nullable: true
                        created_at:
                          type: string
                        updated_at:
                          type: string
                        picked_items:
                          type: number
                        completed_items:
                          type: number
                        retailer_location:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                            taxonomy_id:
                              type: string
                              nullable: true
                            name:
                              type: string
                            retailer_id:
                              type: string
                              nullable: true
                            retailer_name:
                              type: string
                              nullable: true
                            store_number:
                              type: string
                              nullable: true
                            location_route_order:
                              type: array
                              nullable: true
                              items:
                                type: string
                            address:
                              type: object
                              nullable: true
                              properties:
                                address_1:
                                  type: string
                                  nullable: true
                                address_2:
                                  type: string
                                  nullable: true
                                city:
                                  type: string
                                  nullable: true
                                province:
                                  type: string
                                  nullable: true
                                postal_code:
                                  type: string
                                  nullable: true
                                country_code:
                                  type: string
                                phone:
                                  type: string
                                  nullable: true
                              required:
                                - address_1
                                - address_2
                                - city
                                - province
                                - postal_code
                                - country_code
                                - phone
                          required:
                            - id
                            - taxonomy_id
                            - name
                            - retailer_id
                            - retailer_name
                            - store_number
                            - location_route_order
                            - address
                        retailer:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                            display_name:
                              type: string
                            brand_logo_url:
                              type: string
                              nullable: true
                          required:
                            - id
                            - name
                            - display_name
                            - brand_logo_url
                      required:
                        - id
                        - retailer_location_id
                        - sweep_date
                        - sweep_number
                        - scheduled_start_time
                        - scheduled_end_time
                        - actual_start_time
                        - actual_end_time
                        - status
                        - driver_id
                        - total_items
                        - total_load
                        - created_at
                        - updated_at
                        - retailer_location
                        - retailer
                  total:
                    type: number
                required:
                  - sweeps

````