Changelog
Job reference now available on Employment
Deprecated: query-string credentials on `POST /v1/auth`
Announced: 2016-June-01
Removal date: 2026-December-04
Affected endpoint: POST /v1/auth
Status filter in list persons endpoint
We have added a new status query parameter to the GET /v2/persons endpoint to allow filtering by a person's latest employment status.
Reporting API V2 Endpoints
We have introduced a new reporting API. This makes it possible to access reports and attributes data from our new report builder on our analytics 2.0 platform via API. The new API will enable access to all your new reports including new data points that are not available via the reporting API V1 such as new compensation attributes like target earnings, total payout, goal bonus and bonus payout as well as new attendance attributes for project and location tracking.
Deprecation of Attendances and Projects V1 Endpoints
The attendance and projects v1 endpoints will be deprecated in favor of their v2 versions with the final deprecation date set for Aug 30, 2026. All integrations using these v1 endpoints must migrate to the v2 APIs to ensure continued service for our mutual customers. Please share this important update with your technical team.
Hiring Team Array in Recruiting API
We have introduced a new hiring_team array to the Recruiting API responses for both applications and jobs. This array lists all persons assigned as responsible for a job or application. If no persons are assigned to a job, the array will be empty.
Improved attendance project tracking capabilities are exposed through the V2 Projects and Project Members endpoints
- newly introduced advanced Project attributes are returned when getting and listing Projects and can be set when creating and updating Projects.
- a new concept of Subprojects exists which are modeled by setting a
parent_project.id. - new endpoints also exist for managing employee assignment to projects (for projects that have not been assigned to any individual, the
assigned_to_allattribute controls whether it is available to all employees to track or to none).
Fixed Missing Termination Fields in Employments (Credential Refresh Required)
We identified an issue with the GET /v2/persons/{person_id}/employments endpoint where three fields within the termination object were not being returned as expected. Specifically, the following attributes were omitted from the response:
Absolute URLs in Pagination Links for Attendance Periods API V2
Summary:
