HR Partner Lookups API

Read system lookup definitions for configurable fields.

OpenAPI Specification

hr-partner-lookups-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: HR Partner REST Absences Lookups 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: Lookups
  description: Read system lookup definitions for configurable fields.
paths:
  /lookups:
    get:
      tags:
      - Lookups
      operationId: listLookups
      summary: List Lookups
      description: List system lookup definitions for configurable fields.
      responses:
        '200':
          description: List of lookup definitions.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Lookup'
components:
  schemas:
    Lookup:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        values:
          type: array
          items:
            type: string
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key