openapi: 3.1.0
info:
  title: HR Partner REST Absences Reviews API
  description: HR Partner is a cloud-based human resources management SaaS platform from HR Partner Software Pty Ltd (Australia), aimed at organizations of roughly 20 to 500 employees. This OpenAPI describes the public HR Partner REST API exposed at https://api.hrpartner.io, covering company information, employee records and sub-modules (contacts, addresses, notes, education, skills, training, assets, benefits, dependents, grievances, positions, renewables, attachments), leave management (requests, balances, absences), timesheets and projects, expenses, recruitment (job listings, applicants, applications, application-stage tracking, interviews), performance (reviews, goals), checklists, reminders, document library, and lookups. Authentication is via API key passed in the x-api-key header.
  version: 1.0.0
  termsOfService: https://hrpartner.io/terms-of-service
  contact:
    name: HR Partner Developer
    url: https://developer.hrpartner.io/
    email: developer@hrpartner.io
  license:
    name: Proprietary
    url: https://hrpartner.io/terms-of-service
servers:
- url: https://api.hrpartner.io
  description: HR Partner Production API
security:
- apiKeyHeader: []
tags:
- name: Reviews
  description: Read performance reviews and scoring.
paths:
  /reviews:
    get:
      tags:
      - Reviews
      operationId: listReviews
      summary: List Performance Reviews
      description: List performance reviews.
      parameters:
      - name: employee
        in: query
        schema:
          type: string
      - name: review_type
        in: query
        schema:
          type: string
      - name: review_status
        in: query
        schema:
          type: string
      - name: reviewer
        in: query
        schema:
          type: string
      responses:
        '200':
          description: List of reviews.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Review'
components:
  schemas:
    EmployeeRef:
      type: object
      properties:
        code:
          type: string
        first_names:
          type: string
        last_name:
          type: string
        full_name:
          type: string
        department:
          type: string
    Review:
      type: object
      properties:
        id:
          type: string
        review_type:
          type: string
        description:
          type: string
        review_date:
          type: string
          format: date
        reviewer:
          type: string
        score:
          type: number
        review_status:
          type: string
        employee:
          $ref: '#/components/schemas/EmployeeRef'
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key