openapi: 3.0.3
info:
  title: Workday Advanced Compensation Bonus Plans Stock Plans API
  description: The Workday Advanced Compensation API provides RESTful access to compensation management capabilities including compensation plans, merit increases, bonuses, stock awards, compensation grades, budgets, and review processes. The API enables organizations to programmatically manage their total compensation strategy, administer compensation cycles, and integrate compensation data with other systems.
  version: v41.1
  contact:
    name: Workday Developer Support
    url: https://community.workday.com/
  x-generated-from: documentation
servers:
- url: https://{tenant}.workday.com/api/compensation/v1
  description: Workday tenant REST API endpoint
  variables:
    tenant:
      default: wd2-impl-services1
      description: Your Workday tenant hostname
security:
- oauth2: []
tags:
- name: Stock Plans
  description: Manage equity and stock compensation plans
paths:
  /stockPlans:
    get:
      operationId: listStockPlans
      summary: Workday List Stock Plans
      description: Retrieves stock and equity compensation plans including vesting schedules, grant types, and eligibility criteria.
      tags:
      - Stock Plans
      parameters:
      - name: limit
        in: query
        description: Maximum number of records to return
        schema:
          type: integer
          default: 100
        example: 100
      - name: offset
        in: query
        description: Number of records to skip
        schema:
          type: integer
          default: 0
        example: 0
      responses:
        '200':
          description: A list of stock plans
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockPlansResponse'
              examples:
                ListStockPlans200Example:
                  summary: Default listStockPlans 200 response
                  x-microcks-default: true
                  value:
                    total: 4
                    data:
                    - id: SP-001
                      name: Employee Stock Option Plan 2026
                      type: RSU
                      vestingSchedule: FOUR_YEAR_CLIFF
                      grantDateFairValue: 50.0
                      currency: USD
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    StockPlan:
      type: object
      description: An equity or stock compensation plan
      properties:
        id:
          type: string
          description: Unique identifier for the stock plan
          example: SP-001
        name:
          type: string
          description: Name of the stock plan
          example: Employee Stock Option Plan 2026
        type:
          type: string
          description: Type of equity grant
          enum:
          - RSU
          - STOCK_OPTION
          - ESPP
          - PERFORMANCE_SHARE
          example: RSU
        vestingSchedule:
          type: string
          description: Vesting schedule for the grants
          enum:
          - ONE_YEAR_CLIFF
          - TWO_YEAR_CLIFF
          - FOUR_YEAR_CLIFF
          - MONTHLY
          - QUARTERLY
          example: FOUR_YEAR_CLIFF
        grantDateFairValue:
          type: number
          description: Fair market value at grant date
          example: 50.0
        currency:
          type: string
          description: Currency code
          example: USD
    StockPlansResponse:
      type: object
      description: Paginated response containing stock plans
      properties:
        total:
          type: integer
          description: Total number of stock plans
          example: 4
        data:
          type: array
          items:
            $ref: '#/components/schemas/StockPlan'
    ErrorResponse:
      type: object
      description: Workday API error response
      properties:
        error:
          type: string
          description: Error code
          example: INVALID_REQUEST
        message:
          type: string
          description: Human-readable error message
          example: Invalid compensation plan ID
        details:
          type: array
          items:
            type: string
          description: Additional error details
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Unauthorized401Example:
              summary: Unauthorized example
              x-microcks-default: true
              value:
                error: UNAUTHORIZED
                message: Authentication required
  securitySchemes:
    oauth2:
      type: oauth2
      description: Workday OAuth 2.0 authentication
      flows:
        clientCredentials:
          tokenUrl: https://{tenant}.workday.com/ccx/oauth2/{tenant}/token
          scopes:
            compensation.read: Read compensation data
            compensation.write: Write compensation data