Skip to main content
GET
/
timetracking
/
list
Filter time tracking entries
curl --request GET \
  --url http:localhost:3000/v2/timetracking/list \
  --header 'x-API-Key: <api-key>'
[
  {
    "_id": "<string>",
    "number": 123,
    "companyId": "<string>",
    "status": {
      "status": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedAt": "2023-11-07T05:31:56Z",
      "lastModifiedBy": "<string>"
    },
    "chatId": "<string>",
    "userId": "<string>",
    "jobId": "<string>",
    "objectId": "<string>",
    "timeStart": "2023-11-07T05:31:56Z",
    "timeEnd": "2023-11-07T05:31:56Z",
    "workingTime": 1,
    "targetTime": 1,
    "break": 1,
    "requiredBreakTime": 1,
    "type": "default",
    "location": {
      "latitude": 123,
      "longitude": 123
    },
    "logOutLocation": {
      "latitude": 123,
      "longitude": 123
    },
    "approved": true,
    "cancelled": true,
    "offline": true,
    "generatedByUser": true,
    "editedByManager": true,
    "trackingJobDate": "2023-11-07T05:31:56Z",
    "comment": "<string>",
    "reason": "<string>",
    "errors": [
      "<string>"
    ],
    "allFoundErrors": [
      "<string>"
    ],
    "salaryIds": [
      "<string>"
    ],
    "objectManagerId": "<string>",
    "signingId": "<string>",
    "activityTypeId": "<string>",
    "assignmentId": "<string>"
  }
]

Authorizations

​
x-API-Key
string
header
required

Query Parameters

​
limit
integer
default:50

Maximum number of entries to return

Required range: x <= 500
​
offset
integer
default:0

Number of entries to skip for pagination

Required range: x >= 0
​
sort
string
default:timeStart

Field to sort by

​
userId
string<objectid>

Filter by user ID

​
from
integer

Filter by creation date from (timestamp)

​
to
integer

Filter by creation date to (timestamp)

​
objectId
string<objectid>

Filter by object ID

​
activityTypeId
string<objectId>[]

Filter to search jobs by activity type IDs. It can handle multiple activity type IDs and also includes checks for assignments, jobs, and salaries.

Activity Type ID to filter by

​
status
string

Filter by status (single value or comma-separated list)

​
timeTrackingNotApproved
object

Filter for time tracking entries that are not approved

Response

Time tracking entries retrieved successfully

​
_id
string<objectid>

Unique identifier for the time tracking entry Unique identifier of the entity

​
userId
string<objectid>

ID of the user who performed the work

​
jobId
string<objectid>

ID of the job being tracked

​
objectId
string<objectid>

ID of the customer object/location where work was performed

​
timeStart
string<date-time>

Start timestamp of the work period (UTC)

​
timeEnd
string<date-time>

End timestamp of the work period (UTC)

​
workingTime
integer

Actual working time in seconds (timeEnd - timeStart - break)

Required range: x >= 0
​
targetTime
integer

Target/expected working time in seconds

Required range: x >= 0
​
break
integer

Break time in seconds

Required range: x >= 0
​
requiredBreakTime
integer

Legally required break time in seconds

Required range: x >= 0
​
type
enum<string>

Type of time tracking entry

Available options:
default,
simple,
offline,
driving,
manual
​
location
object

GPS coordinates where work started

​
logOutLocation
object

GPS coordinates where work ended

​
approved
boolean

Whether the time tracking entry has been approved for billing

​
cancelled
boolean

Whether the time tracking entry has been cancelled

​
offline
boolean

Whether the entry was created while offline

​
generatedByUser
boolean

Whether the entry was manually created by a user

​
editedByManager
boolean

Whether the entry was modified by a manager

​
trackingJobDate
string<date-time>

Date for which the work was scheduled/performed (UTC)

​
comment
string

Additional comments or notes about the work performed

​
reason
string

Reason for manual time tracking entry creation

​
errors
string[]

Array of error codes preventing automatic salary release

​
allFoundErrors
string[]

Array of all detected errors during time tracking validation

​
salaryIds
string<objectid>[]

Array of salary IDs created from this time tracking entry

​
objectManagerId
string<objectid>

ID of the object manager responsible for this entry

​
signingId
string<objectid>

ID of associated signing document

​
activityTypeId
string<objectid>

ID of the activity type performed

​
assignmentId
string<objectid>

ID of the assignment associated with this time tracking

​
number
integer

Unique number of the entity, used for identification

​
companyId
string<objectid>

The ID of the company this entity belongs to

​
status
object

Entity Status information

​
chatId
string<objectid> | null

ID of the chat associated with this entity