Returns all time entries of the specified task.

GET

https://api.awork.com/api/v1/tasks/:taskId/timeentries

GET

/api/v1/tasks/:taskId/timeentries

curl https://api.awork.com/api/v1/tasks/taskId/timeentries \
     -H "Authorization: Bearer <token>"

200Retrieved

[
  {
    "timezone": "Europe/Berlin",
    "typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
    "isBillable": true,
    "isBilled": false,
    "taskId": "123e4567-e89b-12d3-a456-426614174000",
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "note": "I created a first draft for the new sitemap",
    "startDateUtc": "2022-03-01T00:00:00Z",
    "startTimeUtc": "09:21:00",
    "endDateUtc": "2022-03-01T18:21:05Z",
    "endTimeUtc": "11:45:00",
    "startDateLocal": "2022-03-01T00:00:00",
    "startTimeLocal": "10:21:00",
    "endDateLocal": "2022-03-01T17:21:05",
    "endTimeLocal": "12:45:00",
    "duration": 8635,
    "breakDuration": 1,
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "createdOn": "2024-01-15T09:30:00Z",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedOn": "2024-01-15T09:30:00Z",
    "typeOfWork": {
      "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
      "name": "Design",
      "icon": "thumb_up",
      "isArchived": false
    },
    "user": {
      "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
      "firstName": "Carla",
      "lastName": "Creative",
      "hasImage": true,
      "isExternal": true
    },
    "task": {
      "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
      "name": "Design",
      "baseType": "projecttask",
      "taskIdentifier": "string",
      "taskStatusId": "123e4567-e89b-12d3-a456-426614174000",
      "typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
      "project": {
        "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
        "name": "Design",
        "projectStatus": {
          "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
          "name": "Design",
          "description": "Work in progress",
          "type": "todo",
          "isArchived": false
        },
        "company": {
          "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
          "name": "Design",
          "hasImage": true,
          "description": "One of our customers"
        },
        "projectType": {
          "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
          "name": "Design",
          "icon": "thumb_up",
          "isArchived": false
        },
        "projectKey": "string",
        "isPrivate": false,
        "hasImage": true,
        "isExternal": true,
        "isBillableByDefault": true,
        "createdBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "projectId": "123e4567-e89b-12d3-a456-426614174000",
      "plannedDuration": 21600,
      "closedOn": "2024-01-15T09:30:00Z",
      "taskStatus": {
        "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
        "name": "Design",
        "description": "Work in progress",
        "type": "todo",
        "order": 1,
        "icon": "arrow_forward"
      },
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "correlationId": "123e4567-e89b-12d3-a456-426614174000",
      "parentId": "123e4567-e89b-12d3-a456-426614174000",
      "parentTask": {
        "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
        "name": "Design"
      }
    },
    "project": {
      "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
      "name": "Design",
      "projectStatus": {
        "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
        "name": "Design",
        "description": "Work in progress",
        "type": "todo",
        "isArchived": false
      },
      "company": {
        "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
        "name": "Design",
        "hasImage": true,
        "description": "One of our customers"
      },
      "projectType": {
        "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
        "name": "Design",
        "icon": "thumb_up",
        "isArchived": false
      },
      "projectKey": "string",
      "isPrivate": false,
      "hasImage": true,
      "isExternal": true,
      "isBillableByDefault": true,
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "breaks": [
      {
        "startDate": "2022-01-01T12:00:00Z",
        "duration": 3600,
        "endDate": "2022-01-01T13:00:00Z"
      }
    ],
    "resourceVersion": 637825154598057900,
    "isExternal": true
  }
]

Required Permissions

Any authenticated user.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

taskIdstringRequiredformat: "uuid"

The id of the task.

Query parameters

pageintegerOptionalDefaults to 1

Page number for pagination

pageSizeintegerOptionalDefaults to 10

Number of items per page

orderbystringOptional

The properties to order by

filterbystringOptional

The filter expression to filter by

Response

timezonestring>=1 character

The original timezone of the time tracking. The format of the timezone is the IANA standard.

typeOfWorkIdstringformat: "uuid"

The id of the type of work.

isBillablebooleanOptional

Whether the time tracking is billable or not.

isBilledbooleanOptional

Whether the time tracking is billed or not.

taskIdstring or nullOptionalformat: "uuid"

The id of the task.

projectIdstring or nullOptionalformat: "uuid"

The id of the project.

notestring or nullOptional

The note of the time tracking.

startDateUtcstring or nullOptionalformat: "date-time"

The date (in UTC) when the time tracking was started.

startTimeUtcstring or nullOptional

The time (in UTC) when the time tracking was started.

endDateUtcstring or nullOptionalformat: "date-time"

The date (in UTC) when the time tracking was stopped.

endTimeUtcstring or nullOptional

The time (in UTC) when the time tracking was stopped. Required when the time tracking has already been completed and Duration has not been set.

startDateLocalstring or nullOptionalformat: "date-time"

The date (in Local) when the time tracking was started.

startTimeLocalstring or nullOptional

The time (in Local) when the time tracking was started.

endDateLocalstring or nullOptionalformat: "date-time"

The date (in Local) when the time tracking was stopped.

endTimeLocalstring or nullOptional

The time (in Local) when the time tracking was stopped. Required when the time tracking has already been completed and Duration has not been set.

durationinteger or nullOptional

The duration of the time tracking in seconds. Required when the time tracking has already been completed and EndTime has not been set.

breakDurationinteger or nullOptional

The duration of the break in seconds. Cannot be set via API.

userIdstring or nullOptionalformat: "uuid"

The id of the user. Can be null if the user was deleted.

idstringOptionalformat: "uuid"

The id of the time tracking.

createdBystringOptionalformat: "uuid"

The id of the user who created this time tracking.

createdOnstringOptionalformat: "date-time"

The date this time tracking was created.

updatedBystringOptionalformat: "uuid"

The id of the user who last updated this time tracking.

updatedOnstringOptionalformat: "date-time"

The date this time tracking was last modified.

typeOfWorkobjectOptional

userobjectOptional

taskobjectOptional

projectobjectOptional

breakslist of objects or nullOptional

The breaks of the time tracking.

resourceVersionlongOptionalRead-only

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

isExternalbooleanOptional

True if this entity is coming from an external workspace (awork Connect).