HollyHR Developer Docs

HollyHR
Sign in
Manage API keys

Start Here
Core API
AI and MCP
API Reference
Recipes
Resources

Inspect the authenticated API key contextget

Inspect the public API metadata catalogueget

Organisation guide

Fetch organisation account detailsget

List active organisation locationsget

List active peopleget

Create a personpost

Fetch one personget

Update a personpatch

Fetch one person's elevated personal profileget

Fetch one person's profile avatar URLget

Fetch a person's organisation linksget

Fetch a person's custom-field valuesget

Update a person's custom-field valuespatch

Fetch a person's time-off balance explanationget

List a person's leave-balance ledger historyget

Create a leave-balance adjustmentpost

End a personpost

Reactivate a personpost

Get a person's employment detailsget

Update a person's employment detailspatch

List a person's employment-history rowsget

Create a person's employment-history entrypost

Fetch one employment-history rowget

Correct an employment-history rowpatch

Org Units guide

List organisation unitsget

Create an organisation unitpost

Fetch one organisation unitget

Archive an organisation unitdelete

Update an organisation unitpatch

Reactivate an organisation unitpost

Working Patterns

Working Patterns guide

List working patternsget

Create a working patternpost

Fetch one working patternget

Archive a working patterndelete

Update a working patternpatch

Fetch a person's time-off balance explanationget

List a person's leave-balance ledger historyget

Create a leave-balance adjustmentpost

List time-off recordsget

Create a time-off recordpost

List who is outget

Fetch one time-off recordget

Update a time-off recordpatch

Cancel a time-off recordpost

Fetch time-off settingsget

Update time-off settingspatch

List public holidays for the organisation countryget

Documents guide

List document metadataget

Fetch one document metadata recordget

Custom Fields guide

List API-visible custom-field definitionsget

Fetch a person's custom-field valuesget

Update a person's custom-field valuespatch

Reference Data guide

List country reference dataget

List profile status reference dataget

List work type reference dataget

List work place reference dataget

List time-off status reference dataget

List organisation time-off category reference dataget

Create a time-off categorypost

Fetch one time-off categoryget

Archive a time-off categorydelete

Update a time-off categorypatch

List document type reference dataget

Provider Mappings

List active provider mappingsget

Payroll Readiness Export guide

Download the payroll readiness exportget

Webhook Management guide

List webhooksget

Create a webhookpost

Fetch one webhookget

Disable a webhookdelete

Update a webhookpatch

Rotate a webhook signing secretpost

Queue a webhook test deliverypost

List webhook deliveriesget

Fetch webhook healthget

Fetch one webhook deliveryget

Redeliver a webhook deliverypost

HollyHR API Reference

HollyHR API Reference

Download schema

Foundation public API for Pro organisations. This version covers API-key context, people directory sync, safe people setup, conditional setup-field updates, safe lifecycle actions, safe employment writes, canonical org-unit reads and person org links, working-pattern reads and writes, safe time-off writes, time-off sync, public holidays, document metadata sync, reference data, and outbound webhook management. Responses use explicit deny-by-default projections and encrypted public ids; orgId is always resolved from the bearer key and is never accepted from request input.

Tags

API-key context.

Safe company profile and active location reads.

People directory projections, safe people setup, safe setup-field updates, and safe lifecycle actions.

Canonical organisation-structure reads for departments, teams, divisions, cost centres, legal entities, and location groups.

Working Patterns

Reusable working-pattern templates, contracted hours, and FTE assignment data.

Time-off records, safe time-off writes, and public holidays. Notes, reasons, and approval decisions are excluded.

Read-only document metadata; file bytes are not exposed.

Custom field definitions and person custom-field values for provider and partner mappings.

Read-only low-PII lookup catalogues.

Provider Mappings

Active external/provider ID reconciliation metadata. Requires provider_mappings:read plus the relevant resource read scope.

Safe export packages for operational handoff. Native payroll/accounting connectors and raw payroll-sensitive values are not exposed.

Outbound webhook management, signing, and test delivery.

Security Schemes

ApiKeyAuth

Bearer token

http

Servers

/api/v1

Public API path on the current HollyHR app origin.