> ## 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 leave requests

> Returns leave requests from Deputy, optionally filtered by status.



## OpenAPI

````yaml api-reference/v1/openapi.yaml get /v1/scanner/leave
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/leave:
    get:
      tags:
        - Scheduling
      summary: List leave requests
      description: Returns leave requests from Deputy, optionally filtered by status.
      parameters:
        - schema:
            type: string
            enum:
              - pending
              - approved
              - declined
            description: Filter by leave status
            example: pending
          required: false
          name: status
          in: query
      responses:
        '200':
          description: List of leave requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  leaveRequests:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        employeeName:
                          type: string
                        employeeId:
                          type: number
                        leaveType:
                          type: string
                        startDate:
                          type: string
                          nullable: true
                        endDate:
                          type: string
                          nullable: true
                        totalDays:
                          type: number
                        status:
                          type: string
                        reason:
                          type: string
                          nullable: true
                        approvedBy:
                          type: string
                          nullable: true
                      required:
                        - id
                        - employeeName
                        - employeeId
                        - leaveType
                        - startDate
                        - endDate
                        - totalDays
                        - status
                        - reason
                        - approvedBy
                  deputy_configured:
                    type: boolean
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - leaveRequests
                  - deputy_configured

````