openapi: 3.1.0
info:
  title: Workday Integration Workday Performance Management API
  description: >-
    API for managing employee performance reviews, goals, and feedback. Supports
    performance review cycles, feedback badge management, and goal tracking
    across the organization.
  version: v1
  contact:
    name: Workday API Support
    email: api-support@workday.com
    url: https://community.workday.com
  license:
    name: Proprietary
    url: https://www.workday.com/en-us/legal/site-terms.html
servers:
  - url: https://{baseUrl}/ccx/api/performanceManagement/v1/{tenant}
    description: Workday Performance Management REST API server
    variables:
      baseUrl:
        default: wd2-impl-services1.workday.com
      tenant:
        default: tenant
security:
  - OAuth2:
      - r:performanceManagement
paths:
  /feedbackBadges:
    get:
      operationId: getFeedbackBadges
      summary: Workday Integration Retrieve feedback badges
      description: >-
        Returns the available feedback badges that can be awarded to workers.
      tags:
        - Feedback
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response with feedback badges
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeedbackBadgesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /feedbackBadges/{ID}:
    get:
      operationId: getFeedbackBadgeById
      summary: Workday Integration Retrieve a specific feedback badge
      description: >-
        Returns the specified feedback badge with its details.
      tags:
        - Feedback
      parameters:
        - $ref: '#/components/parameters/ID'
      responses:
        '200':
          description: Successful response with the feedback badge
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeedbackBadge'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /workers/{ID}/goals:
    get:
      operationId: getWorkerGoals
      summary: Workday Integration Retrieve goals for a worker
      description: >-
        Returns the performance goals for the specified worker.
      tags:
        - Goals
      parameters:
        - $ref: '#/components/parameters/ID'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response with worker goals
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoalsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /workers/{ID}/performanceReviews:
    get:
      operationId: getWorkerPerformanceReviews
      summary: Workday Integration Retrieve performance reviews for a worker
      description: >-
        Returns the performance review records for the specified worker.
      tags:
        - Performance Reviews
      parameters:
        - $ref: '#/components/parameters/ID'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response with performance reviews
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PerformanceReviewsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://{baseUrl}/authorize
          tokenUrl: https://{baseUrl}/oauth2/{tenant}/token
          scopes:
            r:performanceManagement: Read performance data
  parameters:
    ID:
      name: ID
      in: path
      required: true
      schema:
        type: string
    limit:
      name: limit
      in: query
      schema:
        type: integer
        default: 20
        maximum: 100
    offset:
      name: offset
      in: query
      schema:
        type: integer
        default: 0
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
    ResourceReference:
      type: object
      properties:
        id:
          type: string
        descriptor:
          type: string
        href:
          type: string
          format: uri
    FeedbackBadge:
      type: object
      properties:
        id:
          type: string
        descriptor:
          type: string
        name:
          type: string
        description:
          type: string
        isActive:
          type: boolean
    FeedbackBadgesResponse:
      type: object
      properties:
        total:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/FeedbackBadge'
    GoalsResponse:
      type: object
      properties:
        total:
          type: integer
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              descriptor:
                type: string
              name:
                type: string
              status:
                type: string
              dueDate:
                type: string
                format: date
              completionPercentage:
                type: number
    PerformanceReviewsResponse:
      type: object
      properties:
        total:
          type: integer
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              descriptor:
                type: string
              reviewPeriod:
                type: string
              overallRating:
                type: string
              manager:
                $ref: '#/components/schemas/ResourceReference'
              completionDate:
                type: string
                format: date
tags:
  - name: Feedback
  - name: Goals
  - name: Performance Reviews