HR Partner

HR Partner Employees API

Read, create, and update employee records.

Documentation GitHub OpenAPI

Operations 3

GET /employees List Employees #

GET /employee/{employeeCode} Get Employee #

POST /employee/{employeeCode} Create Or Update Employee #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/hr-partner-employees-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: HR Partner REST Employees 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.
  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: Employees
  description: Read, create, and update employee records.
paths:
  /employees:
    get:
      tags:
      - Employees
      operationId: listEmployees
      summary: List Employees
      description: Returns all employees in the HR Partner account with optional filtering.
      parameters:
      - name: search
        in: query
        schema:
          type: string
      - name: department
        in: query
        schema:
          type: string
      - name: location
        in: query
        schema:
          type: string
      - name: group
        in: query
        schema:
          type: string
      - name: position
        in: query
        schema:
          type: string
      - name: employment_status
        in: query
        schema:
          type: string
      - name: gender_identity
        in: query
        schema:
          type: string
      - name: is_active
        in: query
        schema:
          type: boolean
      - name: is_terminated
        in: query
        schema:
          type: boolean
      - name: reports_to
        in: query
        schema:
          type: string
      responses:
        '200':
          description: List of employees.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Employee'
  /employee/{employeeCode}:
    get:
      tags:
      - Employees
      operationId: getEmployee
      summary: Get Employee
      description: Retrieve a single employee by code.
      parameters:
      - name: employeeCode
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A single employee.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
    post:
      tags:
      - Employees
      operationId: upsertEmployee
      summary: Create Or Update Employee
      description: Create a new employee or update an existing one by code.
      parameters:
      - name: employeeCode
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Employee'
      responses:
        '200':
          description: Created or updated employee.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
components:
  schemas:
    Employee:
      type: object
      properties:
        id:
          type: string
        code:
          type: string
        first_names:
          type: string
        last_name:
          type: string
        full_name:
          type: string
        date_of_birth:
          type: string
          format: date
        gender_identity:
          type: string
        department:
          type: string
        location:
          type: string
        position:
          type: string
        employment_status:
          type: string
        email:
          type: string
        started_at:
          type: string
          format: date
        finished_at:
          type: string
          format: date
        avatar:
          type: string
        can_logon:
          type: boolean
        portal_username:
          type: string
        custom_data:
          type: object
        tags:
          type: array
          items:
            type: string
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key