Sign in

9bdc11bd523f

latestOpenAPI 3.0.02026-08-1414712532.5 KB
[v3] Time Entry

Get time entries by user permissions

Deprecated. This endpoint is being moved to /time-entries/list. Get time entries by user access and permissions.

post/v3/time-entries

Request body

startDatestring date required

Start date

endDatestring date required

End date

userIdsinteger[]

Array of user ids

taskIdsinteger[]

Array of task ids

tagIdsinteger[]

Array of tag ids

matchAllTagsboolean

Whether all provided tagIds must be assigned to each returned entry

approvalModeboolean

Whether legacy approval mode permissions should be used

includeTagsboolean

Whether tag data should be included in returned entries

withSubtasksboolean

Whether taskIds or taskSelector exact rules should include subtasks

useLegacyDefaultUserScopeboolean

Whether empty userIds should use the legacy default user scope from v1 entries endpoints

useTimeTrackingDashboardDefaultUserScopeboolean

Deprecated alias for useLegacyDefaultUserScope

Example request

{
  "startDate": "2022-01-01",
  "endDate": "2022-01-31",
  "taskSelector": [
    85753039
  ]
}

Response

OK response

idinteger required

Entry id

durationinteger required

Duration in seconds

lockedinteger required

Whether the time entry is locked

invoice_idinteger required

Invoice id

last_modifystring date-time required

Last modify date

datestring date required

Time entry date

start_timestring required

Start time in HH:mm:ss format

end_timestring required

End time in HH:mm:ss format

billableboolean required

Is billable

descriptionstring nullable

Time entry description

addons_external_idstring required

External ID of the related task

hasEntryLocationHistoryboolean

Whether the time entry has location history

Example response

[
  {
    "id": 1,
    "duration": 300,
    "invoice_id": 1,
    "last_modify": "2022-01-01 10:05:00",
    "date": "2022-01-01",
    "start_time": "15:00:00",
    "end_time": "16:00:00",
    "user": {
      "id": 1,
      "email": "john.doe@example.com",
      "display_name": "John Doe"
    },
    "task": {
      "id": 1,
      "name": "My task",
      "note": "Task note",
      "color": "#000000"
    },
    "tags": [
      {
        "id": 1,
        "name": "My first tag",
        "tag_list": {
          "id": 1,
          "name": "Tag list"
        }
      }
    ]
  }
]