API 2.0 / 

Time Reports

Query time reports by user

Retrieve list of user's time reports for a specified period of time
/user/USER-ID/time-reports

Parameters

Name Required Type/Format Description
startDate no YYYY-MM-DD Start date filter
endDate no YYYY-MM-DD End date filter

Response

Sample response →
[
    {
        "momentCreated": "2016-06-09T12:00:00",
        "project": {
            "id": "PROJECT-ID",
            "name": "UI Design"
        },
        "reportDate": "2018-06-09",
        "task": {
            "id": "TASK-ID",
            "name": "test task"
        },
        "taskMessage": null,
        "timeReported": 180
    },
]

Query time reports by task

List of time reports for a specific task
/task/TASK-ID/time-reports

Parameters

Name Required Default Type/Format Description
subtasks no False Boolean set to true to include time reports for all subtasks
startDate no YYYY-MM-DD Start date filter
endDate no YYYY-MM-DD End date filter

Response

Sample response →
[
    {
        "momentCreated": "2018-06-09T12:00:00",
        "project": {
            "id": "PROJECT-ID",
            "name": "UI Design"
        },
        "reportDate": "2018-06-09",
        "task": {
            "id": "TASK-ID",
            "name": "test task"
        },
        "taskMessage": null,
        "timeReported": 180
    },
    ...
]

Query time reports by project

List of time reports for a specific folder/project
/project/PROJECT-ID/time-reports

Parameters

Name Required Default Type/Format Description
subfolders no False Boolean set to true to include time reports for all subprojects
startDate no YYYY-MM-DD Start date filter
endDate no YYYY-MM-DD End date filter

Response

Sample response →
[
    {
        "momentCreated": "2018-06-22T12:00:00",
        "reportDate": "2018-06-22",
        "taskId": "TASK-ID",
        "taskMessage": null,
        "timeReported": 20,
        "userId": "USER-ID"
    },
    ...
]

New Time Report

Submit a new time report.
/task/TASK-ID/time-report

Parameters

Name Required Type/Format Description
userId yes String User on behalf of whom API will report time
date no YYYY-MM-DD Date you want to report time for, current date will be set if not passed
reportedMinutes yes Integer Reported time in minutes
message no String Comment