Workday Advanced Compensation Compensation Reviews API

openapi: 3.0.3
info:
  title: Workday Advanced Compensation Bonus Plans Compensation Reviews 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: Compensation Reviews
  description: Manage compensation review processes and cycles
paths:
  /compensationReviews:
    get:
      operationId: listCompensationReviews
      summary: Workday List Compensation Reviews
      description: Retrieves compensation review process instances including status, participants, and completion tracking.
      tags:
      - Compensation Reviews
      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
      - name: status
        in: query
        description: Filter by review status
        schema:
          type: string
          enum:
          - IN_PROGRESS
          - COMPLETED
          - NOT_STARTED
        example: IN_PROGRESS
      responses:
        '200':
          description: A list of compensation reviews
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompensationReviewsResponse'
              examples:
                ListCompensationReviews200Example:
                  summary: Default listCompensationReviews 200 response
                  x-microcks-default: true
                  value:
                    total: 2
                    data:
                    - id: CR-001
                      name: 2026 Annual Compensation Review
                      status: IN_PROGRESS
                      startDate: '2026-03-01'
                      endDate: '2026-04-30'
                      completionPercent: 65
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    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
    CompensationReview:
      type: object
      description: A compensation review process instance
      properties:
        id:
          type: string
          description: Unique identifier for the review
          example: CR-001
        name:
          type: string
          description: Name of the compensation review
          example: 2026 Annual Compensation Review
        status:
          type: string
          description: Current status of the review
          enum:
          - NOT_STARTED
          - IN_PROGRESS
          - COMPLETED
          - CANCELLED
          example: IN_PROGRESS
        startDate:
          type: string
          format: date
          description: Start date of the review period
          example: '2026-03-01'
        endDate:
          type: string
          format: date
          description: End date of the review period
          example: '2026-04-30'
        completionPercent:
          type: integer
          description: Percentage of review tasks completed
          example: 65
    CompensationReviewsResponse:
      type: object
      description: Paginated response containing compensation reviews
      properties:
        total:
          type: integer
          description: Total number of reviews
          example: 2
        data:
          type: array
          items:
            $ref: '#/components/schemas/CompensationReview'
  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