Get basic company information from HR Partner: company name, subscription status and expiry, employee counts, and timezone. Useful for validating the API key is connected to the correct company.

Get a list of employees in HR Partner with optional filters. Returns summary details per employee (code, name, department, location, position, status flags, dates). Use get_employee with the employee 'code' for full details including contacts, addresses and custom fields.

Get full details for a single employee by Employee Code, including contact details, addresses, tags, and any custom fields configured for the company. Use list_employees first to find employee codes.

Get a contact-centric list of employee contact records across multiple employees. Individual employee contacts are also included in the get_employee response.

Get a flat list of employee addresses across employees. Individual employee addresses are also included in the get_employee response.

Create a new employee or update an existing one in HR Partner (upsert by Employee Code). Only supplied fields are modified. Custom fields go in custom_data (only the keys you want to change are needed). New values for department/location/position/employment_status are added to the lookup lists automatically. Note: tags, contacts and addresses can be added/updated but NOT deleted via the API.

Get employee absence records (leave taken, or TOIL/Flexi leave added). Includes absence reason, status, dates, duration, physician/certificate details and attachments.

Get company assets allocated to employees (e.g. phones, laptops), including identifiers, serial numbers, allocation/return dates and attachments.

Get file attachments stored against employee records, with description (file name), download URL, size, and the module they belong to.

Get employee benefit records (health cover, allowances etc.) including type, status, provider, value and dates.

Get employee dependent / next-of-kin records including type, name, contact details and date of birth.

Get employee education history records including institution, qualification, type, status and commence/completion dates.

Get employee grievance / complaint / harassment records including type, status, description, actioned-by and reported dates.

Get employee interview / meeting records including type, interviewer, description and dates.

Get employee notes including note text, hashtags, created/updated dates and optional change-event history.

Get employee position (job) history records including position name, remuneration, pay level and commence/completion dates.

Get employee renewable document records (licences, certifications, visas etc.) including type, description, issue date and renewal due date.

Get employee review records (probation reviews, performance check-ins etc.) including type, status, reviewer, score and review dates. For full performance review forms see list_performances.

Get employee skill records including skill name, rating and comments.

Get employee training course records including type, status, course name, institution, cost, reimbursement and commence/completion dates.

Get company and employee goals with scope, type, target/current values, completion and due dates.

Get employee checklists (onboarding/offboarding etc.) with status, progress percentage, assigned/completed dates.

Get upcoming employee birthdays (active, non-terminated employees only) with calculated age. Filter by month range and optionally forecast ages for a future year.

Get upcoming employee work anniversaries (active, non-terminated employees only) with years worked. Filter by month range and optionally forecast service length for a future year.

Get documents from the HR Partner document library (policies, handbooks etc.), optionally limited to one category. Returns description, download URL, size and timestamps.

Get the document library category list. The 'detailed' view also includes parent and child category relationships.

Get the valid values for an HR Partner lookup list (departments, locations, positions, absence reasons, review types, tags etc.). Use this to discover valid filter values for the other tools. Lookups are read-only via the API.

Get admin reminders with description, module, remind date, notification flags and the responsible user/employee.

Get a single reminder by its unique ID. Use list_reminders to find reminder IDs.

Update a reminder's description and flags. Note: the employee, admin user and reminder date CANNOT be changed via the API, only the description and the notification/active flags.

Permanently delete a reminder by its unique ID. This cannot be undone.

Get employee leave (time off) requests with status, absence reason (leave policy), dates, duration and description. Use get_leave_request for full approval detail on one request.

Get a single leave request by ID, including approver action history, approval conditions, extended employee details and file attachments. Use list_leave_requests to find IDs.

Get employee leave balances per leave policy: entitlement, current balance, carryover, units and accrual details. Warning: balances are slow to compute, so always filter to the smallest dataset needed (e.g. a single employee or policy).

Get employee expense claims. The report_type controls the shape: 'detailed' returns claim headers plus expense lines and attachments, 'summary' returns claim headers only, 'transaction' returns expense lines only.

Get project/activity costing entries (from timesheets and expenses) with employee, project, activity, currency, hours/cost and transaction dates.

Get performance review cycles with status, template, assigned/review/completed dates. Optionally include individual form statuses (employee/manager/peer/user) and the full questions and answers (significantly increases response time, so combine with other filters).

Get recruitment job listings with title, department, location, position, publish dates and flags. Use get_job with the job id/slug for full detail including application form, scorecard and pipeline stages.

Get a single job listing by its unique job ID/slug (e.g. 'forklift-driver-oz0H'), including selection panel, custom application form definition, scorecard, pipeline stages and full text/web content. Use list_jobs to find job IDs.

Get recruitment applicants (candidates). Search matches first name, last name or email (including email domain).

Get a single applicant by unique ID or email address, including their job applications with stage, scores and flags.

Create a new applicant or update an existing one (upsert by email). Can also link the applicant to one or more job listings and move them to a pipeline stage (the stage name must already exist).

Get applications for a specific job listing (the API cannot list applications across all jobs at once). Includes applicant details, stage, source, flags and custom form answers.

Get a single job application by its numeric ID, including applicant details, stage, job listing, custom form answers, scorecards, attachments, interviews and comments. Use list_applications to find application IDs.

Create a new job application or update an existing one. Also upserts the applicant by email. An invalid stage name results in the company default stage (usually 'Applied'). Custom form answers are keyed by the form field names from the job listing's custom form (see get_job).

Get the history of job applications moving between recruitment pipeline stages. Maximum 500 records per response, so use filters to stay below the limit.

Get timesheet data grouped by timesheet template, sequence (period), employee and individual time entries. Warning: can return a LOT of data; always use date ranges or employee filters to avoid timeouts.

Get a single employee's timesheet for one sequence (period). Returns the same structure as list_timesheets for one employee/sequence combination.

Add a timesheet/timeclock entry for an employee. Times are the employee's LOCAL time in 'yyyy-mm-dd hh:mm' format. Entries can only be added to OPEN timesheet sequences, and the timeclock module must be enabled for the company and the employee's timesheet template. Identify the employee with either employee_code or employee_email.