BAbamboohr
Time Tracking
Public API

Get Time Tracking Time Clock

Changed on

Retrieves a single time tracking time clock by its ID. Device health flags are reported as null while device status is temporarily unavailable.

OAuth Scopes: time_tracking:time_clocks

get/api/v1/time-tracking/time-clocks/{id}

Request

Path parameters

idstring uuid required

The time tracking time clock ID.

Response

Successfully retrieved the time clock.

idstring uuid

The unique identifier for the time clock.

namestring

The name of the time clock.

serialNumberstring

The manufacturer serial number of the device.

type'TIME_CLOCK' | 'TIME_CLOCK_PLUS'

The hardware model of the time clock.

onlineboolean nullable

Whether the device is reachable. Null when device status is temporarily unavailable.

configOnlineboolean nullable

Whether the device is receiving configuration updates. Null when device status is temporarily unavailable.

dataOnlineboolean nullable

Whether the device is sending clock data. Null when device status is temporarily unavailable.

firmwareOnlineboolean nullable

Whether the device is receiving firmware updates. Null when device status is temporarily unavailable.

timezonestring

IANA timezone name the device records clock entries in.

Example response

{
  "id": "a3f1c2d4-5b6e-4f70-8a91-2c3d4e5f6a7b",
  "name": "Warehouse Entrance",
  "serialNumber": "GT4-0001234",
  "type": "TIME_CLOCK",
  "online": true,
  "configOnline": true,
  "dataOnline": true,
  "firmwareOnline": true,
  "timezone": "America/Denver"
}

Changes