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

# Get leave requests

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



## OpenAPI

````yaml api-reference/v1/openapi.yaml get /v1/scheduling/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/scheduling/leave:
    get:
      tags:
        - Scheduling
      summary: Get leave requests
      description: Get leave requests from Deputy, optionally filtered by status.
      parameters:
        - schema:
            type: string
            enum:
              - pending
              - approved
              - declined
            description: Filter by status
          required: false
          name: status
          in: query
      responses:
        '200':
          description: Leave requests data
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      leave_requests:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                            employee_name:
                              type: string
                            employee_id:
                              type: number
                            leave_type:
                              type: string
                            start_date:
                              type: string
                            end_date:
                              type: string
                            total_days:
                              type: number
                            status:
                              type: string
                              description: Status
                              example: pending
                            reason:
                              type: string
                              nullable: true
                            approved_by:
                              type: string
                              nullable: true
                          required:
                            - id
                            - employee_name
                            - employee_id
                            - leave_type
                            - start_date
                            - end_date
                            - total_days
                            - status
                            - reason
                            - approved_by
                          description: Leave request
                      deputy_configured:
                        type: boolean
                        enum:
                          - true
                    required:
                      - leave_requests
                      - deputy_configured
                    description: Get leave response
                  - type: object
                    properties:
                      message:
                        type: string
                      error:
                        type: string
                      deputy_configured:
                        type: boolean
                        enum:
                          - false
                    required:
                      - deputy_configured
                    description: Deputy not configured response
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  leave_requests:
                    type: array
                    items:
                      nullable: true
                  error:
                    type: string
                  message:
                    type: string
                  deputy_configured:
                    type: boolean
                    enum:
                      - true
                required:
                  - leave_requests
                  - error
                  - deputy_configured
                description: Get leave error response

````