DEVELOPER RESOURCES
TimeTrex API Documentation & Integration
Connect TimeTrex with your business systems to synchronize employee records, record time punches and export reports.
Explore API methods, available fields and request examples in our interactive reference. Follow the getting started guide, test requests using your TimeTrex installation and generate code examples for your preferred language.
Have your company’s TimeTrex URL and registered API key ready.
YOUR FIRST API REQUEST
Start with a simple read.
Retrieve up to five employee records using the prepared request in the reference.
POST /api/json/api.php
Class APIUser
Method getUser
Authentication Your registered API key
This introductory request reads records without changing employee data.
Get started in three steps
Step 1
Register your API key
Sign in to your TimeTrex installation as the employee whose permissions the integration should use. Register a key from Passwords / Security.
Step 2
Follow the getting started guide
Learn where to enter your TimeTrex URL and key, how requests are structured and how to read the response.
Step 3
Retrieve your first records
Open the prepared employee request and choose Test Request. Enter your URL and key, then send the read-only example.
Build your next integration
Go directly to the methods, fields and examples for the task you want to automate.
Employee records
Find employees, create records and keep employee information synchronized between systems.
Time punches
Retrieve employee punches and follow the examples for recording and pairing In and Out punches.
Timesheet reports
Retrieve timesheet summary report data and use the documented report configuration and export examples.
Register an API key
An API key identifies the employee making the request. Calls use that employee’s permissions in the same TimeTrex installation.
Keep the key private, like a password. If registration is unavailable, ask your TimeTrex administrator for help.
- Sign in to TimeTrex as the employee whose permissions the integration should use.
- Open your profile menu in the top-right corner.
- Select Passwords / Security.
- Open the More (…) menu and select Register API Key.
- Keep the provided API key / Session ID for your integration.
In the interactive reference, enter the key under Authentication → SessionID and use your company’s TimeTrex base URL. The key and URL must belong to the same installation.
WHEN YOU ARE READY TO AUTOMATE
Find the request behind a TimeTrex screen
Use API tracing to inspect the class, method and arguments sent by the TimeTrex web interface. It is a useful next step after your first request works.
- Go to the TimeTrex login screen.
- Press Ctrl + Alt + Shift + F11. A message should confirm that API tracing is enabled.
- Press F12 to open your browser’s developer tools, then select the Console tab.
- Perform the action in TimeTrex and inspect its logged API request.
Use the request details with your registered API key. Read the automation guide →
More developer resources
PHP integrations
Use the shipped TimeTrexClientAPI.class.php helper to handle API requests and responses.
Imports & scheduled exports
For CSV imports and regular report exports, start with the ready-made scripts in TimeTrex Remote API Tools.
Responses & OpenAPI
Understand result values, pagination and error details. Download OpenAPI documents from the reference for use with compatible developer tools.
The reference includes JSON and YAML downloads for the selected documentation section or API class.
Ready to connect your systems?
Start with one request, then explore the methods your integration needs.
Saving businesses time and money through better workforce management since 2003.
Copyright © 2026 TimeTrex. All Rights Reserved.