Returns time reports of a user. | awork API

Returns time reports of a user. The response includes details for the selected time range.

Authentication

AuthorizationBearer

Send your token in the Authorization: Bearer <token> header. See Authentication for API keys and OAuth.

Responses

200 OK

application/json

sharedbooleanOptional

Whether the time report is shared.

dateModestring or nullOptional

The date mode of the time report. Can be: "today", "yesterday", "selectDate", "selectWeek", "currentWeek", "lastWeek", "selectMonth", "currentMonth", "lastMonth", "selectQuarter", "currentQuarter", "lastQuarter", "selectYear", "currentYear", "lastYear", "customRange", "noFilter".

startOnstring or nullOptional

format: date-time

The start date time of the report when DateMode is "customRange".

endOnstring or nullOptional

format: date-time

The end date time of the time report. when DateMode is "customRange". Currently the start of the end day.

filterstring or nullOptional

The generated filter query of the time report.

chartTypestring or nullOptional

The actual chart type of the time report. Can be: "group" or "time".

projectIdstring or nullOptional

format: uuid

The id of the project of the time report. Used for the pdf reports.

companyIdstring or nullOptional

format: uuid

The id of the company of the time report. Used for the pdf reports.

sumBystring or nullOptional

Summarises the values by the sum of this property.

sortBystring or nullOptional

Sorts the values by this property.

sortByOrderstring or nullOptional

The way how to sort the data. Can be: "asc", desc".

roundBystring or nullOptional

Rounding method of the time report. Can be: "nearQuarter", "nearHalf", "nearHour", "upQuarter", "upHalf", "upHour".

groupBystring or nullOptional

Group the values by property.

sortColumnstring or nullOptional

Sort the values of the time report by a column.

sortGroupsEnabledboolean or nullOptional

Whether sorting of groups is enabled.

availableColumnsarray of string or nullOptional

List of shown Columns in the time report. Can be: "status", "duration", "task", "timeTrackingNote", "typeOfWork", "project", "date", "time", "user", "client", "projectType", "projectRole", "plannedDuration", "taskList", "key".

billingStatusesarray of string or nullOptional

Filter of bill satuses of the time report. Can be: "billed", "notBilled", "notBillable".

notestring or nullOptional

Filter time entries by note.

usersFilterarray of string or nullOptional

Filter time entries by users.

projectsFilterarray of string or nullOptional

Filter time entries by projects.

noProjectFilterboolean or nullOptional

Filter to show also time entries without a project.

projectCompaniesFilterarray of string or nullOptional

Filter time entries by projects of the companies.

projectTypesFilterarray of string or nullOptional

Filter time entries by projects of the type.

projectStatusesNameFilterarray of string or nullOptional

Filter time entries by projects with status name.

projectStatusTypesFilterarray of string or nullOptional

Filter time entries by projects with status of type.

projectTeamsFilterarray of string or nullOptional

List of teams, to the filter the projects for.

userTeamsFilterarray of string or nullOptional

Filter for the teams to filter the users.

taskTagsModelFilterarray of object or nullOptional

Filter time entries by the tags of the task.

Show 4 properties

idstringOptional

format: uuid

The Id of the tag.

namestring or nullOptional

The name of the tag.

colorstring or nullOptional

The color of the tag.

entityIdstringOptional

format: uuid

The id of the entity the tag is related to.

projectTagsModelFilterarray of object or nullOptional

Filter time entries by the tags of the project.

Show 4 properties

idstringOptional

format: uuid

The Id of the tag.

namestring or nullOptional

The name of the tag.

colorstring or nullOptional

The color of the tag.

entityIdstringOptional

format: uuid

The id of the entity the tag is related to.

userTagsModelFilterarray of object or nullOptional

Filter time entries by the tags of the users.

Show 4 properties

idstringOptional

format: uuid

The Id of the tag.

namestring or nullOptional

The name of the tag.

colorstring or nullOptional

The color of the tag.

entityIdstringOptional

format: uuid

The id of the entity the tag is related to.

typesOfWorkFilterarray of string or nullOptional

Group the time report by the type of works.

namestring or nullOptional

The name of the time report.

idstringOptional

format: uuid

The id of the time report.

userobjectOptional

Show 4 properties

idstringOptional

format: uuid

The identifier of the nested model.

firstNamestring or nullOptional

The first name of the user.

lastNamestring or nullOptional

The last name of the user.

hasImageboolean or nullOptional

Whether this user has a profile image.

updatedOnstringOptional

format: date-time

The date this time report was updated.

resourceVersionintegerOptional

format: int64

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

[ { "shared": true, "dateMode": "lastMonth", "startOn": null, "endOn": null, "filter": "projectId eq guid'b870a84e-c7fa-e711-80c2-00155d3163ca'", "chartType": "group", "projectId": "123e4567-e89b-12d3-a456-426614174000", "companyId": "123e4567-e89b-12d3-a456-426614174000", "sumBy": "UserId", "sortBy": "CreatedOn", "sortByOrder": "asc", "roundBy": "upHour", "groupBy": null, "sortColumn": null, "sortGroupsEnabled": true, "availableColumns": [ "duration", "user" ], "billingStatuses": [ "notBilled" ], "note": null, "usersFilter": [ "123e4567-e89b-12d3-a456-426614174000" ], "projectsFilter": [ "123e4567-e89b-12d3-a456-426614174000" ], "noProjectFilter": null, "projectCompaniesFilter": [ "123e4567-e89b-12d3-a456-426614174000" ], "projectTypesFilter": [ "123e4567-e89b-12d3-a456-426614174000" ], "projectStatusesNameFilter": [ "string" ], "projectStatusTypesFilter": [ "string" ], "projectTeamsFilter": [ "123e4567-e89b-12d3-a456-426614174000" ], "userTeamsFilter": [ "123e4567-e89b-12d3-a456-426614174000" ], "taskTagsModelFilter": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Design", "color": "purple", "entityId": "123e4567-e89b-12d3-a456-426614174000" } ], "projectTagsModelFilter": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Design", "color": "purple", "entityId": "123e4567-e89b-12d3-a456-426614174000" } ], "userTagsModelFilter": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Design", "color": "purple", "entityId": "123e4567-e89b-12d3-a456-426614174000" } ], "typesOfWorkFilter": [ "123e4567-e89b-12d3-a456-426614174000" ], "name": "Project report for March 2022", "id": "123e4567-e89b-12d3-a456-426614174000", "user": { "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d", "firstName": "Carla", "lastName": "Creative", "hasImage": true }, "updatedOn": "2026-01-15T09:30:00Z", "resourceVersion": 637825154598057900 } ]