time-tracking

View time entries

Get an overview of time entries.

Time Tracking explained

HoorayHR Time Tracking works by dividing time into entries. Each time entry spans a single day or a week (Mon-Sun). The time span of an entry is determined by the time tracking policy of the user.

Each entry has a list of activities. Activities are like work periods or breaks. Activities cannot overlap, but one can start at the same time as the previous one ends to create a continuous work period.

Activities of type WORK can have labels and notes attached, while activities of type BREAK cannot.

Time entries are created automatically based on the provided dates of the activities. It is only possible to create activities and entries within active time tracking policies for users.

get/time-tracking

Request

  • Base URL: https://api.hoorayhr.io
  • URL: https://api.hoorayhr.io/time-tracking
  • Auth: API key in header authorization

Query parameters

id[$in]number[]

Filter entries by specific IDs

status'NOT_LOGGED' | 'CONCEPT' | 'REQUEST' | 'APPROVED' | 'DENIED'

Filter entries by a specific status

userIdnumber

Filter entries by a specific user

startDatestring date

Filter entries by a specific start date

endDatestring date

Filter entries by a specific end date

createdAtstring date

Filter entries by a specific creation date

updatedAtstring date

Filter entries by a specific update date

Response

List of time entries

idinteger required
userIdinteger required
startDatestring date required
endDatestring date required
period'DAY' | 'WEEK' required
status'NOT_LOGGED' | 'CONCEPT' | 'REQUEST' | 'APPROVED' | 'DENIED' required
createdAtstring date-time required
updatedAtstring date-time required

Example response

[
  {
    "activities": [
      {
        "timezone": "Europe/Amsterdam",
        "notes": "Optional notes for the activity",
        "labels": [
          {
            "id": 5,
            "name": "Project epsilon",
            "type": "TIME_TRACKING",
            "systemCategoryType": "car",
            "createdAt": "2022-02-23T14:01:17.516Z",
            "updatedAt": "2022-02-23T14:01:17.516Z"
          }
        ]
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.