v2023-03-01

This is the changelog for v2023-03-01, which contains breaking changes.

To learn more about versions in our API, read the Versioning guide.

Sensitive Data Scope Control

v2023-03-01 adds additional scope controls for protecting sensitive data on certain endpoints, while minimizing disruptions to existing partner applications by excluding out-of-scope data rather than rejecting the request.

The additional scopes requirements included in this version are as follows:

Endpoint	Endpoint Scope	Additional Scope Requirements
Get the current user	N/A	`email` field requires `company_admin:read` scope `tier` field requires `companies:read` scope Work `locations` requires `companies:read` scope Non-work `locations` requires `employees:read` scope
Get a company	`companies:read`	`primary_payroll_admin` field requires `company_admin:read` scope `primary_signatory` field requires `signatories:read` scope `home_address` field requires `employees:read` scope Non-work `locations` requires `employees:read` scope
Get all payrolls for a company	`payrolls:read`	When passing `benefits` in the `include` parameter, the `employee_benefits:read` scope is required
Get a single payroll	`payrolls:read`	When passing `benefits` in the `include` parameter, the `employee_benefits:read` scope is required
Get a company benefit	`company_benefits:read`	When passing `true` for the `with_employee_benefits` parameter, the `employee_benefits:read` scope is required