Integrations

Each guide below covers one area of data, employees, time, payroll, or organization structure, with the endpoints, request shapes, and response fields you need for it. Start with whichever matches what you're building.

Guides

Sync Employees: discover companies, pull employee records, and resolve employees connected across companies
Employee Write-Back: update work location or schedule a termination from your system
Organization Structure: traverse organizations, companies, departments, and locations
Time & Attendance: retrieve or submit time punches and earnings for any date range
Payroll Reference Data: look up earnings, deduction, and tax codes
Submit Payroll Data: submit pending earnings and deductions, and manage recurring deductions like 401k
Export Payroll Data: pull payroll runs, paychecks, and GL journal entries
File-Based Import: for systems that can only export a file, upload it directly instead

Before you start on any of them

A few things apply across every guide above.

Start from your accessible companies

Most integrations begin by discovering which companies your API key can see:

GET /companies?api-version=3.0

Store the companyId values from the response, you'll pass them as filters to almost every other endpoint in these guides.

Align date ranges to pay periods

Endpoints that take a start-date and end-date, punches, earnings, payroll data, expect those to line up with your pay period boundaries. A range that splits a pay period can double-count or drop records on the edges.

Page until you run out of results

Endpoints that return a PagedResponse<T> envelope need repeated calls to collect everything. See Pagination for the exact fields to check.

Inaccessible data doesn't always error the same way

On collection filters, a company-id or employee-id your API key can't see is typically dropped from the response rather than erroring — design each integration to handle an empty or partial result set as a normal case. But this isn't universal: single-resource lookups by ID can 404, and some endpoints (the v1 pay-rates endpoint, the v3 shifts endpoints) return 403 for an out-of-scope company instead. See Error Handling for the endpoint-by-endpoint breakdown.