v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Time Tracking

Public API

Get Time Tracking Shift Differential

Retrieves a single time tracking shift differential by its ID. Archived shift differentials are returned normally; soft-deleted shift differentials return 404.

OAuth Scopes: time_tracking:shift_differentials

get/api/v1/time-tracking/shift-differentials/{id}

Path parameters

idinteger required

The shift differential ID.

Response

Successfully retrieved the shift differential.

idinteger

The ID of the shift differential.

namestring

The name of the shift differential rule.

ratestring

The differential pay rate as a decimal string.

rateType'AMOUNT' | 'PERCENT'

How the rate is applied.

allowAllEmployeesboolean

Whether all time & attendance employees are assigned.

employeeIdsinteger[]

Employee IDs assigned to this shift differential.

createdAtstring date-time nullable

ISO 8601 timestamp when the shift differential was created.

updatedAtstring date-time nullable

ISO 8601 timestamp when the shift differential was last updated.

archivedAtstring date-time nullable

ISO 8601 timestamp when the shift differential was archived.

deletedAtstring date-time nullable

ISO 8601 timestamp when the shift differential was deleted.

Example response

{
  "id": 1,
  "name": "Night Shift Premium",
  "rate": "12.00",
  "rateType": "AMOUNT",
  "allowAllEmployees": true,
  "times": [
    {
      "id": 22,
      "startDay": "MONDAY",
      "endDay": "MONDAY",
      "start": "00:00",
      "end": "04:00"
    }
  ],
  "employeeIds": [
    1,
    2,
    3
  ],
  "createdAt": "2026-01-29T18:52:50Z",
  "updatedAt": "2026-02-09T17:56:06Z"
}