Introduction

The Netchex External API gives your platform direct, authenticated access to the HR, payroll, time, and benefits data managed inside Netchex. Whether you're building a payroll export, syncing employee records, or pulling time punches into a scheduling tool, this API is the integration layer.

What you can do

• Read and write employee data: names, departments, job titles, compensation, custom fields, plus work location assignment and termination
• Sync org structure: organizations, companies, divisions, business units, departments, locations, and which departments each employee is assigned to
• Bring payroll data in and export it out: submit pending earnings and deductions ahead of a run, or pull paycheck history, earnings, deductions, and GL data afterward
• Bring time & attendance data in: punches and direct-entry earnings, submitted or pulled back for reconciliation
• Read benefits and time-off data: enrolled plans, dependent information, and time-off requests. These are read only today, there's no submission path
• Read and write shift schedules: create, list, and remove shifts

How it works

All requests authenticate with an API key issued by Netchex. See Authentication for header formats and key lifecycle.

The API is versioned via the api-version query parameter. v3 is the recommended version for new integrations, it has cleaner resource paths, consistent pagination, and full OpenAPI documentation. v1 remains available for existing integrations and for the endpoints that haven't been rebuilt on v3 yet (see Getting Started for which is which).

Explore the docs