Sign in

v1

latestOpenAPI 3.0.02026-07-14800227.2 KB
Attendance

Return a list of attendances.

This endpoint returns an array of objects with all the existing attendance entries within Kenjo for a maximum of 31 days, defined by the required params from and to. Every object contains an attendance entry.

get/attendances

Query parameters

fromstring required
Example:2021-02-01

A date in format YYYY-MM-DD to indicate the starting point.

tostring required
Example:2021-02-04

A date in format YYYY-MM-DD to indicate the ending point.

Headers

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

A valid bearer token.

Response

OK

_idstring

The Kenjo _id of the returned attendance entry.

userIdstring

The Kenjo _id of the employee assigned to the attendance entry.

emailstring

The Kenjo email of the employee assigned to the attendance entry.

externalIdstring

The external id of the employee assigned to the attendance entry.

startTimestring

The start date time of the attendance entry.

endTimestring

The end date time of the attendance entry.

breakTimestring

The break time of the attendance entry. 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": "80a2db290da29e126a18789a",
    "email": "john@acme.io",
    "userId": "83a2db290da29e126a18789a",
    "externalId": "00001",
    "startTime": "2021-07-01T10:00:00.000Z",
    "endTime": "2021-07-01T12:00:00.000Z",
    "breaks": [
      {
        "start": "11:00:00",
        "end": "11:30:00"
      }
    ],
    "breakTime": 30,
    "attendanceCategoryId": "70a2db290da29e126a18789a",
    "attendanceSubCategoryId": "70a2db290da29e126a18789b",
    "comment": "Morning working attendance tracking."
  },
  {
    "_id": "80a2db290da29e126a18789b",
    "email": "anna@acme.io",
    "userId": "85a2db290da29e126a18789a",
    "externalId": "00003",
    "startTime": "2021-07-02T09:00:00.000Z",
    "endTime": "2021-07-02T18:00:00.000Z",
    "breaks": [
      {
        "start": "11:00:00",
        "end": "11:30:00"
      },
      {
        "start": "13:00:00",
        "end": "14:00:00"
      }
    ],
    "breakTime": 90,
    "attendanceCategoryId": "70a2db290da29e126a18789a",
    "attendanceSubCategoryId": "70a2db290da29e126a18789b"
  },
  {
    "_id": "80a2db290da29e126a18789c",
    "email": "joaquin@acme.io",
    "userId": "88a2db290da29e126a18789a",
    "externalId": "00009",
    "startTime": "2021-08-01T10:00:00.000Z",
    "endTime": "2021-08-01T12:00:00.000Z",
    "attendanceCategoryId": "70a2db290da29e126a18789a"
  },
  {
    "_id": "80a2db290da29e126a18789d",
    "email": "pedro@acme.io",
    "userId": "81a2db290da29e126a18789a",
    "externalId": "00009",
    "startTime": "2021-08-02T14:00:00.000Z",
    "endTime": "2021-08-02T18:00:00.000Z",
    "comment": "I've taken the morning off."
  }
]