API Explorer

The Workers APIs support the management of workers in an organization. A worker is a person who performs duties and responsibilities for an organization. In that capacity, a worker fills one or more positions via a work assignment. For a given work assignment, a worker is related to the organization as an employee or contractor. The Workers APIs can be used to obtain a list of all workers in an organization and to get information about work assignments.

This API provides the time period (start and end date), in/out punches, pay code name and amounts, labor entry details, and daily and shift totals.

A Pay Statement describes the details of a payment made to a payee. These details include the net and gross payment amounts, deductions, earnings, and year-to-date payroll accuals. The Pay Statements APIs can be used to retrieve the list of a specified number of pay statements for an associate or to get details for a specific statement.

Worker payroll instructions are used to specify recurring general deductions, garnishments, and retirement plan deductions for a specified worker. The Worker Payroll Instructions v1 APIs are used to start or stop payroll instructions for a worker, or to change an instruction that was previously started. You can also view all of the payroll instructions for a worker. API metadata is available.

The Worker Demographics APIs return a list of demographics for each worker in an organization, demographics for a specific worker, and API metadata.

This API supports the processing of a collection data collection

The Job Applications v2 APIs are used to retrieve a job application or a list of applications, or to submit a job application. API metadata is also available.

Time Off APIs support the viewing of time off balances, and the viewing of time off requests if the worker is allowed to make requests. In addition, if the user is authorized, the APIs support requesting time off, and approving time off by a manager.

The list of clock entries for a worker