The Matrix TimeCard API lets your own systems keep your time clock up to date. An ERP, an accounting package or a project tool can use it. Your system writes the Jobs, Phase Codes, Work Orders, Meet Points and equipment that your crews clock in to. Matrix TimeCard then shows them on the phone app and checks every punch against them.
Who this API is for
This API is for developers who connect a company system to Matrix TimeCard. You need an API key from an administrator of your Matrix TimeCard account.
What you can do
- Create and update Jobs, with their site address, time zone and job-site boundary.
- Add, rename and deactivate the Phase Codes on a Job.
- Keep your equipment list in step with your fleet system.
- Propose changes for an administrator to approve, in batches of up to 1,000.
Start here: read Getting started. In about 10 minutes you will create your first Job and update it.
Base URL
Each Matrix TimeCard account has its own API address. Ask your administrator or support@matrixtimecard.com for it. It has this form:
https://<your-instance-host>/api/v1
Every path in these docs comes after /api/v1. For example, the list of Jobs is
GET https://<your-instance-host>/api/v1/activities?kind=Job.
Words we use
| Word | Meaning |
|---|---|
| Activity | Anything a worker can clock in to. There are three kinds: Job, WorkOrder and MeetPoint. |
| Job | A construction job or project. It is an activity with kind: "Job". |
| Phase Code | A cost code under a Job or Meet Point. A worker picks one when they clock in. |
| Work Order | A maintenance or shop task. It can be linked to a Job and to one piece of equipment. |
| Meet Point | A yard or gathering place where a crew meets before it travels to a site. |
| Boundary (geofence) | The area around a job site. The phone checks that a worker is inside it to clock in. |
| Company | One of the companies in your Matrix TimeCard account, named by its companyCode. |
| Source system | The name of the system that owns a record. Your API key writes with its own source system name. |
Contents
| Page | What it tells you |
|---|---|
| Getting started | Get a key, make your first call, and write to a Job step by step |
| Authentication | How to send your API key, key scopes, and how to keep a key safe |
| Errors | The error format, every error code, and when to retry |
| Conventions | Responses, paging, codes, dates, locations, ownership and safe updates |
| Activities | Create, read, update and import Jobs, Work Orders and Meet Points |
| Phase Codes | Manage the Phase Codes on one Job, or on many Jobs at once |
| Boundaries | Turn a job-site boundary off or on |
| Equipment | Create, read, update, deactivate and reactivate equipment |
| Proposed changes | Send changes that an administrator approves before they go live |
| Reference lists | The fixed values that some fields accept |
| Terms and limits | Rate limits, size limits and terms of use |
| Use with AI agents | Give an AI agent the skill file and the raw Markdown pages |
| Changelog | What changed in the API, by date |
Support
Email support@matrixtimecard.com. Include the code and detail from the error
response, the request method and path, and the time of the request (UTC).