AWawork-io
TimeEntries

Returns simplified time entries.

Changed on

Returns simplified time entries grouped by the requested property when one is supplied. <Check title="Required Permissions" icon="key">The user must have permission to view the returned time entries.</Check>

get/timeentries/simplified

Request

  • Base URL
    https://api.awork.com/api/v2
  • URL
    https://api.awork.com/api/v2/timeentries/simplified
  • Auth
    OAuth 2
    Authorization code: https://api.awork.com/accounts/authorize
    Token URL: https://api.awork.com/accounts/token scopes: full_access

Query parameters

groupingstring

The grouping type.

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page

orderbystring

The properties to order by

filterbystring

The filter expression to filter by

Response

OK

idstring uuid

The id of the time entry.

isBillableboolean

Whether the time entry is billable or not.

isBilledboolean

Whether the time entry is billed or not.

durationinteger nullable

The duration of the time entry in seconds. Not set if the time entry is still running.

startDatestring date-time

The start date and time of the time entry. Required. If the time entry is date only, the time should be 00:00:00.

endDatestring date-time nullable

The end date and time of the time entry. Not set if the time entry is still running. If the time entry is date only, it should be the same as the start date.

taskIdstring uuid nullable

The id of the task.

projectIdstring uuid nullable

The id of the project.

userIdstring uuid nullable

The id of the user.

typeOfWorkIdstring uuid nullable

The id of the type of work.

createdBystring uuid

The id of the user who created this time entry.

createdOnstring date-time

The date of the creation of this time entry.

Example response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isBillable": true,
    "duration": 8635,
    "task": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "projectId": "123e4567-e89b-12d3-a456-426614174000",
      "correlationId": "123e4567-e89b-12d3-a456-426614174000",
      "parentId": "123e4567-e89b-12d3-a456-426614174000",
      "taskStatusId": "123e4567-e89b-12d3-a456-426614174000",
      "taskStatus": {
        "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
        "name": "Design",
        "description": "Work in progress",
        "type": "todo",
        "order": 1,
        "icon": "arrow_forward"
      },
      "primaryTaskListId": "123e4567-e89b-12d3-a456-426614174000",
      "primaryTaskList": {
        "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
        "name": "Design"
      }
    },
    "taskId": "123e4567-e89b-12d3-a456-426614174000",
    "project": {
      "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
      "name": "Design",
      "company": {
        "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d"
      }
    },
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "user": {
      "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
      "firstName": "Carla",
      "lastName": "Creative",
      "hasImage": true
    },
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "typeOfWork": {
      "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
      "name": "Design",
      "icon": "thumb_up"
    },
    "typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Changes

  • v22efdeb36681cRevision changes
    • info

      api operation id GetTimeEntriesSimplifiedV2 was added

  • v26a1bfd839871Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status