--- title: HR Partner API Integration on Truto slug: hrpartner category: HRIS canonical: "https://truto.one/integrations/detail/hrpartner/" --- # HR Partner API Integration on Truto **Category:** HRIS **Status:** Generally available ## Unified APIs ### Unified HRIS API - **Benefits** — Benefits represent the benefits for an Employee - **Companies** — Companies represent the companies in HRIS - **Employees** — Represents an employee in HRIS - **Employments** — Employments represent a job position at a company. - **Groups** — Groups represent the groups for an Employee - **Job Roles** — Represent the job roles in a company - **Tags** — The tags represent a tag for a employee. - **Timeoff Balances** — Represent the time off balances for an Employee - **Timeoff Policies** — Represent the time off policies in a company - **Timeoff Requests** — Represent the time off requests for an Employee ## How it works 1. **Link your customer's HR Partner account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach HR Partner.** The Proxy API is a 1-to-1 mapping of the HR Partner API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Automate employee provisioning and deprovisioning across your SaaS app** — Sync employee lifecycle events from HR Partner to automatically create, update, or revoke user accounts in your product. When an employee is marked inactive or terminated, trigger immediate access removal without manual intervention. - **Power role-based access control with live org data** — Read job roles, groups, and tags from HR Partner to dynamically assign permissions, license tiers, or feature access within your SaaS product — ensuring the right people have the right access as roles change. - **Sync time-off data for workforce capacity planning** — Fetch approved time-off requests, balances, and policies from HR Partner so your scheduling, project management, or payroll tool can accurately reflect who's available and when, without double-entry. - **Drive employee engagement workflows from HR data** — Use employee records, start dates, and group memberships to trigger automated onboarding sequences, birthday celebrations, or peer recognition — and suppress notifications when employees are on leave. - **Automate spend controls based on employment status** — Corporate card and expense management platforms can sync employees, employments, and job roles from HR Partner to issue cards for new hires and freeze them instantly when someone departs. ## What you can build - **Real-time employee directory sync** — Automatically populate and maintain a searchable employee directory in your app using employees, groups, and job roles from HR Partner. - **Automated onboarding and offboarding triggers** — Detect new hires and terminations from employment status changes to kick off provisioning or deprovisioning workflows in your product. - **Dynamic role-based license assignment** — Map HR Partner job roles and tags to your product's permission tiers so license levels adjust automatically as employees change positions. - **Leave-aware scheduling and notifications** — Pull time-off requests and balances to block out unavailable dates in your scheduling tool or suppress non-urgent notifications for employees on leave. - **Org chart and team structure visualization** — Build a live organizational chart from HR Partner's groups and employee data that stays current without manual updates from end users. - **Consolidated benefits and compensation dashboard** — Aggregate benefits data and company metadata from HR Partner into a total compensation view alongside data from other HRIS sources via the Unified API. ## FAQs ### How does authentication work for HR Partner? HR Partner uses API key authentication (x-api-key header). Truto handles storing and managing the API key securely so your end users authenticate once through Truto's connect flow. ### What data models are available through Truto's Unified HRIS API for HR Partner? The Unified HRIS API supports Benefits, Companies, Employees, Employments, Groups, Job Roles, Tags, Timeoff Balances, Timeoff Policies, and Timeoff Requests. These cover the core employee lifecycle and organizational structure data. ### Does Truto support custom tools or endpoints for HR Partner beyond the Unified API? HR Partner does not have pre-built custom tools yet, but Truto builds them on request. If you need access to HR Partner-specific data outside the Unified HRIS API models, reach out and Truto can create custom tools for your use case. ### What types of companies typically connect HR Partner through Truto? HR Partner is popular with SMBs (20–500 employees), especially non-profits, creative agencies, local IT services, and distributed teams. If your product serves these segments, offering HR Partner as an integration option covers a meaningful portion of your user base. ### Does Truto handle pagination and rate limiting for the HR Partner API? Yes. Truto abstracts away pagination and rate limit handling for HR Partner's REST API, so you get consistent, complete data sets through the Unified API without building retry logic or cursor management yourself. ### Can I use the Unified HRIS API to read data from HR Partner alongside other HRIS providers? Absolutely. The Unified HRIS API normalizes data across providers into a consistent schema. You write one integration and it works for HR Partner and every other HRIS Truto supports, with the same data models and response formats.