Featured technology: Paychex workers API endpoint

Use this endpoint to make changes to employee data. GET an array of workers (think of this as “list employees,”) POST a new worker (think of this as “add employee,”) or PATCH an existing worker (think of this as “update employee.”) You cannot currently use this endpoint to DELETE a worker… but maybe that’s a good thing.

https://api.paychex.com/companies/{companyId}/workers

Why Would Your Organization Need This Endpoint?

If your organization frequently hires new employees, or needs to work with employee data based in a different system besides payroll/HRIS, you may want to consider utilizing the workers endpoint. By communicating with the workers endpoint, other systems you use may be able to create, update or read information about employees automatically.

  • POS Integration: restaurants and retail locations may need to frequently synchronize new hire or multi-location employee data.
  • Staffing Tools: staffing industry organizations may prefer to manage new employee information in a separate system, or frequently update employee department information.
  • Recruiting and Applicant Tracking: organizations that use a non-Paychex recruiting or applicant tracking tool may want new hires to automatically flow into the Paychex system.

What Can the Workers API Endpoint Do?

The Workers endpoint can create, update or access information about workers. You will still need to log into the Paychex Flex user interface to complete certain steps like data validation or approving workers, but the API will still allow you to automate many tasks.

Adding an Employee: set your application to POST to the Workers API endpoint and be sure to include the required fields givenName, familyName and workerType, and also your own workerCorrelationId data element to be used as an identifier in response data from this POST operation:

POST https://api.paychex.com/companies/{companyId}/workers
givenName: Robert
familyName: Smith
workerType: EMPLOYEE
workerCorrelationId: myTemporaryEmployeeId-1

Updating an Employee: your application will need to PATCH to theWorkers API endpoint in order to finish adding most of the fields you would want to see in a new employee, or to update employees that were created historically.

PATCH https://api.paychex.com/companies/{companyId}/workers
employeeId: 001234
clockID: 1111829
employmentType: FULL_TIME
exemptionType: EXEMPT
hireDate: 2020-07-01T00:00:00Z
birthDate: 1990-03-17T00:00:00Z
sex: MALE
ethnicityCode: BLACK_OR_AFRICAN_AMERICAN
name: <object>
-- givenName: Robert
-- middleName: Xavier
-- familyName: Smith
-- titleAffixCode: Dr
-- qualificationAffixCode: Jr
-- preferredName: Bob
legalId: <object>
-- legalIdValue: 999-99-9999
-- legalIdType: SSN
organization: <object>
-- organizationId: 970000055981384
-- name: 2 Division B
job: <object>
-- jobTitleId: 00DWS906IMW2JSH8AQJ8
-- title: Integration Expert
supervisor: <object>
-- workerID: 00H2A1IUJ4IPERJ589YE
-- name: <object>
-- -- familyName: Golasino
-- -- givenName: Tom

Reading Employee Information: your application will need to make a GET request to theWorkers API endpoint to list employees – currently the endpoint lists employees that have (at minimum) received a givenName, familyName and legalId.

GET https://api.paychex.com/companies/{companyId}/workers

How Can My Organization Build API Connectors For The Workers Endpoint?

Because Paychex uses an open API architecture, your organization can use any data integration tool to communicate with the Workers API Endpoint – as long as you are able to configure the tool with the correct credentials and authorization protocols. If your organization has an internal IT team or software development resources, you can also create your own applications to connect to the Workers API endpoint.

Valet Data Platform

Ensure payroll accuracy and simplify HCM workflows with Valet – connect your HCM system to external data sources to verify rates, streamline employee data and more.

  • Connect to external rate tables or applications
  • Validate time card or payroll data early in your process before inaccuracies stay in your system
  • Develop custom integrations or applications using Valet
  • Experience fantastic ongoing support

View all features >

Disclaimer: this educational content is provided “as-is” by Custom Interface Company, based on publicly available information, and is not meant to serve as official documentation or representation of functionality within or between any vendor system(s).

Leave a Comment

Your email address will not be published. Required fields are marked *