Datasets · Buildertrend

Buildertrend Time Clocks Dataset

Time card rows from the Time Clock module: one shift per record, with its job, worker, clock in and out, break, overtime split and approval state.

Record type buildertrend:timeClocks

Read it with List records, or the MCP tool list_dataset_records.

Request

curl -G https://api.clickr.cloud/v2/datasets/{datasetId}/records \
  -H "Authorization: Bearer $CLICKR_API_KEY" \
  --data-urlencode "limit=10"

const response = await fetch(`https://api.clickr.cloud/v2/datasets/{datasetId}/records?${new URLSearchParams({
  "limit": "10"
})}`, {
  headers: {
    Authorization: `Bearer ${process.env.CLICKR_API_KEY}`,
  },
});
const data = await response.json();

import os
import requests

response = requests.get(
    "https://api.clickr.cloud/v2/datasets/{datasetId}/records",
    headers={"Authorization": f"Bearer {os.environ['CLICKR_API_KEY']}"},
    params={
        "limit": "10"
    },
)
data = response.json()

Fields

Every field a record can carry. Filter and sort on them by name, as in filter[jobName][contains]=patel. A field without a value can be missing from a record.

timeClockIdstring
Buildertrend's id for the time card. Each time card is one shift, so a worker who clocks into two jobs on one date has two records.
builderIdstring
Buildertrend's id for the builder account.
jobIdstring
Buildertrend's id for the job the shift was worked on. Joins to the Buildertrend Jobs Dataset.
jobNamestring
The name of the job the shift was worked on.
userIdstring
Buildertrend's user id for the worker on the shift.
userNamestring
The worker's full name, as Buildertrend shows it.
firstNamestring
The worker's first name.
lastNamestring
The worker's last name.
shiftDatestring
The shift's date in the jobsite's local time, with no time zone. Clickr resyncs shifts dated in the last 14 days, so edits to older shifts are not picked up.
clockInobject
Where and when the worker clocked in.

clockIn.timeStampstring
When the worker clocked in, as a local date and time with no time zone.
clockIn.latitudenumber
Latitude where the worker clocked in. Absent when no location was recorded.
clockIn.longitudenumber
Longitude where the worker clocked in. Absent when no location was recorded.
clockIn.outOfBoundsboolean
True when Buildertrend's geofence placed the clock-in outside the jobsite.
clockOutobject
Where and when the worker clocked out.
clockOut.timeStampstring
When the worker clocked out, as a local date and time with no time zone. Absent while the shift is still open.
clockOut.latitudenumber
Latitude where the worker clocked out. Absent when no location was recorded.
clockOut.longitudenumber
Longitude where the worker clocked out. Absent when no location was recorded.
clockOut.outOfBoundsboolean
True when Buildertrend's geofence placed the clock-out outside the jobsite.
breakMinutesnumber
Minutes of break taken during the shift.
isOnBreakboolean
True while the worker is on a break.
regularMinutesnumber
Minutes of the shift counted as regular time.
overtimeMinutesnumber
Minutes of the shift counted as overtime.
doubleOvertimeMinutesnumber
Minutes of the shift counted as double overtime.
personalTimeOffMinutesnumber
Minutes of personal time off on the time card.
totalWorkMinutesnumber
Minutes worked on the shift, not hours: 724 is 12 hours 4 minutes. Zero while the shift is still open, and it does not count up as the shift runs.
isApprovedboolean
Whether the time card has been approved.
approvedByNamestring
The name of who last changed the time card's approval, which on an approved card is the approver.
approvedByIdstring
Buildertrend's user id for who last changed the time card's approval.
approvedDatestring
When the time card's approval last changed.
costRatestring
The worker's cost rate as Buildertrend displays it, for example "$19.00". It reflects the worker's current rate, not the rate on the day of the shift.
builderCostnumber
The shift's cost, worked out from its minutes and the worker's current cost rate, so it changes when that rate does.
billableRatestring
The billable rate as Buildertrend displays it. Absent when no billable rate is set.
billableAmountnumber
The billable amount for the shift. Absent, rather than 0, when Buildertrend has no figure, such as when no billable rate is set.
costCodesarray of objects
How the shift's minutes were split across cost codes.
costCodes.idstring
Buildertrend's id for the cost code.
costCodes.titlestring
The cost code's name.
costCodes.minutesnumber
Minutes of the shift charged to this cost code. Can be fractional, such as 724.002.
createdByIdstring
Buildertrend's user id for who created the time card.
createdByNamestring
The name of who created the time card.
createdDatestring
When the time card was created.
notesstring
Notes entered on the time card.
tagsarray
Tags on the time card. The format of each entry has not been confirmed yet.
relatedOwnerInvoicesarray
Owner invoices Buildertrend links to the time card. The format of each entry has not been confirmed yet.
editedobject
The time card's audit trail: who punched in and out and when, and who adjusted the minutes or the break afterwards.
edited.clockInModenumber
Buildertrend's own code for how the clock-in was made. Buildertrend sends no label with it.
edited.clockedInByNamestring
The name of who recorded the clock-in.
edited.clockedInByDatestring
When the clock-in was recorded, as a local date and time with no time zone.
edited.clockOutModenumber
Buildertrend's own code for how the clock-out was made. Buildertrend sends no label with it.
edited.clockedOutByNamestring
The name of who recorded the clock-out.
edited.clockedOutByDatestring
When the clock-out was recorded, as a local date and time with no time zone.
edited.minuteDistributionTypenumber
Buildertrend's own code for how the shift's minutes are distributed. Buildertrend sends no label with it.
edited.minutesUpdatedByNamestring
The name of who adjusted the shift's minutes after it was punched. Absent if nobody has.
edited.minutesUpdatedByDatestring
When the shift's minutes were last adjusted.
edited.breakModifiedByNamestring
The name of who adjusted the shift's break after it was punched. Absent if nobody has.
edited.breakModifiedByDatestring
When the shift's break was last adjusted.
gustoSyncStatusnumber
Buildertrend's own code for the time card's sync to Gusto. Buildertrend sends no label with it, and Clickr does not map it to one.
isDeletedboolean
True once the time card has been removed in Buildertrend. Clickr keeps the record, and notices removals only for shifts dated in the last 14 days.
deletedAtdate and time
When Clickr saw the time card removed.