Introduction
Netchex External API — integrate HR, payroll, and time data into your platform
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 employee data — names, departments, job titles, compensation, custom fields
- Sync org structure — companies, locations, departments, and position assignments
- Export payroll — paycheck history, earnings, deductions, and GL data
- Pull time & attendance — punches, direct-entry earnings, shifts, and time-off requests
- Manage benefits — enrolled plans and dependent information
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.
API keys must be requested through Netchex. If you don't have one yet, request access first.
Explore the docs
Getting Started
Base URL, auth, versioning, and your first request
Authentication
API key formats and how to authorize calls
Pagination
How to page through large result sets
Error Handling
Status codes and how to interpret error responses
Integrations
Guides for common integration patterns
API Reference
Interactive reference for all endpoints