HRIS Private API

This site contains the technical resources required to build internal integrations or automation using CATAPA's private endpoints.

Quick Start!

Copy code below and see it in action!

Python

uv add catapa-private

from catapa_private import CatapaPrivate

client = CatapaPrivate(tenant="zfrl", username="demo", password="dmo-password")
response = client.get("/core/employees", params={"page": 0, "size": 10})
employees = response.json()

print(f"Found {len(employees.content)} employees")

Getting Started

Who is this documentation for?

This section is designed for developers who need to interact with CATAPA features that is not exposed via the Public API. If you are looking to build a standard integration using the Public API, please refer to the Public API Section.

Our Integration Options

To access CATAPA's resources, below are integration options.

Python SDK

Streamline your integration with a high-level Python wrapper designed for the Private API. It eliminates the complexity of manual login handshakes by providing native session persistence and automated credential handling.The SDK is designed to be a complete bridge to the CATAPA Private API. Every endpoint documented in our Swagger is accessible via the SDK, ensuring you have full coverage of all private features and internal resources. Check full documentation here HRIS Python Private API SDK Documentation.