openapi: 3.1.0
info:
  title: HR Partner REST Absences Addresses 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: Addresses
  description: List employee address records.
paths:
  /addresses:
    get:
      tags:
      - Addresses
      operationId: listAddresses
      summary: List Addresses
      description: List employee address records.
      parameters:
      - name: search
        in: query
        schema:
          type: string
      - name: address_type
        in: query
        schema:
          type: string
      - name: location_search
        in: query
        schema:
          type: string
      responses:
        '200':
          description: List of addresses.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Address'
components:
  schemas:
    Address:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        address_1:
          type: string
        address_2:
          type: string
        suburb:
          type: string
        state:
          type: string
        post_code:
          type: string
        country:
          type: string
        employee:
          $ref: '#/components/schemas/EmployeeRef'
    EmployeeRef:
      type: object
      properties:
        code:
          type: string
        first_names:
          type: string
        last_name:
          type: string
        full_name:
          type: string
        department:
          type: string
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key