Retrieve detailed information about a company including basic details, locations, departments, administrators, and signatories. Use this to get a complete overview of a company's setup and configuration. You can optionally include related data like employees, admins, or signatories using the include parameter.

Get all work locations for a company. Locations are critical for payroll processing as they determine tax liability and filing requirements. Each location includes address, filing requirements, and active status. Use this when you need to understand where a company operates or assign employees to locations.

Get all organizational departments for a company. Departments help organize employees and contractors for reporting and management purposes. Each department includes its name, associated employees and contractors. Use this to understand company structure or for reporting and analytics.

List all employees for a company with powerful filtering and search capabilities. Returns employees in all states: onboarding, active, and terminated. Filter by location, payroll, onboarding status, or search by name/email. Sort results by created date, name, or onboarding status. Optionally include related data like compensations, addresses, or custom fields. Essential for employee discovery and reporting.

Retrieve detailed information about a specific employee including personal details, jobs, compensations, addresses, tax information, and onboarding status. Use the include parameter to fetch related data like all compensations, home addresses, or custom fields. Essential when you need complete employee details for a specific person.

Retrieve all custom field values for a specific employee. Custom fields allow companies to track additional employee information beyond standard fields. This returns both the field definitions and the employee's responses. Note that only custom fields with user-provided values are returned; fields without values appear as empty strings.

Get the current home address for an employee. This is useful for payroll processing, tax calculations, and compliance purposes. Returns the employee's active residential address including street, city, state, and zip code.

Check the onboarding progress and status for an employee. Returns detailed information about what steps have been completed, what's pending, and any blockers preventing onboarding completion. Useful for tracking new hire progress and ensuring all required information is collected before the first payroll.

Get all jobs (positions/titles) for an employee. Each job represents a title, location, and pay rate. Employees can have multiple jobs (e.g., part-time in two different roles). Each job has associated compensations that track pay rate changes over time. Use this to understand an employee's roles and responsibilities within the company.

Retrieve detailed information about a specific job including title, location, hire date, and current compensation rate. A job represents an employee's position and includes their current rate field which reflects the active compensation. Use this when you need specific details about an employee's role or pay structure.