PeopleForce
GuidesAPI reference

Early access

Company API v4 is the next-generation API and is under active development. Endpoints and fields may still change.

Changelog

Notable changes to the PeopleForce APIs.

This page records notable changes to the PeopleForce APIs — new endpoints, fields, and behavioural changes — newest first.

Company API v4 is the current line and is under active development. Entries below track v4 changes. Older v1–v3 history from the previous documentation site is not carried over here.

Unreleased

  • GET /api/v4/people/:id now returns the Ukrainian compliance fields that hire compliance processes create, such as ua_tax_id and ua_disability_group. Like any custom field, one is returned only when a role attached to the key grants view access to it. These fields are read-only in v4: POST /api/v4/people and PUT /api/v4/people/:id ignore them.
  • Empty array filters (such as statuses[]=) on GET /api/v4/compliance/compliance_cases and GET /api/v4/compliance/compliance_case_documents are now ignored instead of returning 400. Unknown values still return 400.
  • Added GET /api/v4/leave_requests and GET /api/v4/leave_balances. Both list across every person the service account can see, rather than one person at a time, and both need the new Time off permission on a role attached to the key — without it they return 403. A role that grants Time off but affects nobody gets an empty list, not a 403.
  • Initial v4 documentation: Company API v4 and Careers API v1.

Rate limits

Request limits across the PeopleForce API and how to recover from a 429.

Webhooks overview

Subscribe to PeopleForce events and the full catalog of webhook topics.

On this page

Unreleased