Sign in

v1

latestOpenAPI 3.0.02026-07-14800227.2 KB
Attendance

Return an attendance for a given attendance id.

This endpoint returns one attendance entry specified by attendanceId.

get/attendances/{attendanceId}

Path parameters

attendanceIdstring required
Example:60a2db290da29e126a18789a

The _id of the attendance entry to request.

Headers

Authorizationstring required
Example:Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5rZW5qby5pbyIsInN1YiI6IjYwZjBhOTE2MjE0OTg3MjU2YmU5YzhmZiIsImF1ZCI6Imh0dHBzOi8vYXBpLmtlbmpvLmlvIiwiaWF0IjoxNjI2Mzg1MTE1LCJuYmYiOjE2MjYzODUxMTUsImV4cCI6MTYyNjU1NzkxNSwiYWNjZXNzVHlwZSI6IkFwaUFjY2VzcyIsInNfb3JnSWQiOiI2MGYwNGVhN2RmN2JhMjFlY2U0YmYzYzIifQ.cxG_7dIS-VbmDXdJuLkekoyuyCIzQG2fMcgc0nkfbWE8cihhcb5FnALbQkjU9b5-qVcEoMHZlSuUA-jMEBMMVQ

A valid bearer token.

Response

OK

_idstring

The _id of the requested attendance entry.

userIdstring

The id of the employee associated to the requested attendance entry.

emailstring

The email of the employee associated to the requested attendance entry.

externalIdstring

The external Id of the employee associated to the requested attendance entry.

startTimestring

The start date time of the requested attendance entry.

endTimestring

The end date time of the requested attendance entry.

breakTimenumber

Number of minutes of break time. If there is no 'breaktime' this field will not be in the response. This value is the sum of the total time of breaks.

paidBreakTimenumber

Number of minutes of paid break time. If there is no 'paidBreakTime' this field will not be in the response. This value is the sum of the total time of paid breaks, which can be configured in the settings of the attendance policy.

attendanceCategoryIdstring

The Kenjo _id of the attendance category.

attendanceSubCategoryIdstring

The Kenjo _id of the attendance sub category.

commentstring

Optional text to describe an attendance record (pair of startTime and endTime). The maximum number of characters is 150.

Example response

{
  "_id": "60a2db290da29e126a18789a",
  "userId": "60a2db290da29e126a18789a",
  "email": "john@acme.io",
  "externalId": "000034",
  "startTime": "2021-07-01T10:00:00.000Z",
  "endTime": "2021-07-01T13:00:00.000Z",
  "breaks": [
    {
      "start": "11:00:00",
      "end": "11:30:00"
    }
  ],
  "breakTime": 30,
  "paidBreakTime": 30,
  "attendanceCategoryId": "70a2db290da29e126a18789a",
  "attendanceSubCategoryId": "70a2db290da29e126a18789b",
  "comment": "Morning working attendance tracking."
}