BAbamboohr
Time Tracking
Public API

List Time Tracking Time Clocks

Changed on

Returns a paginated list of the company's time tracking time clocks. Supports an OData-style filter, an orderBy sort expression, and select sparse fieldsets. Results are sorted by name ascending when orderBy is omitted; name ordering is case-insensitive. Filtering and sorting are applied in memory over the cached GT Connect list (partner ordering is not relied on). A company with no GT Clocks connected returns an empty list, not a 404. Device health flags are reported as null while device status is temporarily unavailable. Pagination is page-based via page and pageSize (defaults: page 1, pageSize 20, minimum 10, maximum 100).

OAuth Scopes: time_tracking:time_clocks

get/api/v1/time-tracking/time-clocks

Request

Query parameters

filterstring

OData v4 filter expression. Filterable fields: name, serialNumber, type, timezone. Example: type eq 'TIME_CLOCK'.

orderBystring

Sort expression like name asc, serialNumber desc. Allowed fields: name, serialNumber, type, timezone. Defaults to name asc.

selectstring

Comma-separated list of properties to return (sparse fieldsets).

pageinteger

The page to retrieve. Defaults to 1.

pageSizeinteger

The number of time clocks per page. Defaults to 20, minimum 10, maximum 100.

Response

A paginated list of time clocks.

Example response

{
  "meta": {
    "page": 2,
    "pageSize": 20,
    "totalPages": 4,
    "totalItems": 68
  },
  "data": [
    {
      "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