Changelog

Notable changes to the PeopleForce Company API.

This log records notable changes to the Company API — newest first.

Unreleased

Breaking, for companies on compensation components. New companies start on compensation components. Companies still on compensation types see no change. These apply to /api/public/v2/employees/:employee_id/salaries and its /compensations alias:

  • Creating a salary requires compensation_component_id: the ID of one of the company's base compensation components. Without it the request returns 422.
  • The salary takes its pay period from the component. To pay a salary per year instead of per month, create it with a yearly base compensation component.
  • A request that sends per, overtime, or pay_schedule_id to create or update a salary returns 422 with an error naming the field. An update may send the per the salary already has, so a salary read from the API can be sent back unchanged. A field sent as null counts as not sent.
  • A salary's compensation component cannot change once the salary is saved. Sending a different compensation_component_id returns 422. Delete the salary and create a new one instead.
  • Salary responses include compensation_component, with its id, name, code, payout_type, and frequency. per always matches the component's frequency.

August 16, 2026

  • Candidate CV/resume download URLs (resume_url) are now short-lived, expiring signed URLs (60 minutes) instead of permanent, unauthenticated links. Fetch a fresh URL before each download rather than caching it.

June 29, 2026

April 14, 2024

  • Introduced secrets for webhooks. See Starting with webhooks.
  • Webhooks can now be enabled/disabled in the web application.
  • Added cover_letter to create/update recruitment candidates.
  • Added custom table data to the get-employee response.
  • Added endpoints for time projects and project fields on timesheet entries.

March 14, 2024

  • Added endpoints to manage the company skill list and employee skills.

March 3, 2024

  • Added paid/unpaid and working/non-working info to leave requests.
  • Added endpoints for employee avatar, certifications, documents, and tables.

December 30, 2023

  • Added bulk create/destroy for timesheet entries.

November 26, 2023

April 2, 2023

  • Introduced API v2: custom fields addressed by internal_name (replacing UUIDs); group returned as an object; added an options field for select fields.

On this page