AWawork-io
TimeTracking

Starts a new time tracking for a user.

Changed on

If there is already a running/paused time tracking it will be stopped automatically in order to start the new one.

<Check title="Required Permissions" icon="key">The user must be an admin or the creator.</Check>

post/me/timetracking/start

Request

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

Query parameters

userIdstring uuid

The id of the user.

Request body

isBillableboolean

Whether the time tracking is billable or not.

isBilledboolean

Whether the time tracking is billed or not.

taskIdstring uuid nullable

The id of the task.

projectIdstring uuid nullable

The id of the project.

notestring nullable

The note of the time tracking.

typeOfWorkIdstring uuid required

The id of the type of work of the time tracking.

timezonestring required

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

Example request

{
  "isBillable": true,
  "taskId": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "note": "I created a first draft for the new sitemap",
  "typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
  "timezone": "Europe/London"
}

Response

OK

isBillableboolean

Whether the time tracking is billable or not.

isBilledboolean

Whether the time tracking is billed or not.

taskIdstring uuid nullable

The id of the task.

projectIdstring uuid nullable

The id of the project.

notestring nullable

The note of the time tracking.

isDateOnlyboolean

Whether the time entry is a date only entry.

startDatestring date-time

The date and time when the time entry was started in UTC. Required.

endDatestring date-time nullable

The date and time when the time entry ends in UTC. Not set if the time entry is still running.

timezonestring required

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

durationinteger nullable

The duration of the time tracking in seconds. Required when the time entry is not running.

typeOfWorkIdstring uuid required

The id of the type of work.

userIdstring uuid nullable

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

idstring uuid

The id of the time tracking.

breakDurationinteger nullable

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

createdBystring uuid

The id of the user who created this time tracking.

createdOnstring date-time

The date this time tracking was created.

updatedBystring uuid

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

updatedOnstring date-time

The date this time tracking was last modified.

resourceVersioninteger

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

isExternalboolean

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

Example response

{
  "isBillable": true,
  "taskId": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "note": "I created a first draft for the new sitemap",
  "timezone": "Europe/Berlin",
  "duration": 8635,
  "typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "typeOfWork": {
    "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
    "name": "Design",
    "icon": "thumb_up"
  },
  "user": {
    "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
    "firstName": "Carla",
    "lastName": "Creative",
    "hasImage": true
  },
  "task": {
    "id": "80a2b26b-9fb3-42b5-b6dc-126c437cad5d",
    "name": "Design",
    "baseType": "projecttask",
    "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"
      },
      "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"
      },
      "hasImage": true,
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "plannedDuration": 21600,
    "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"
    },
    "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"
    },
    "hasImage": 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
}

Changes

  • v2573939b95e06Revision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

  • v22efdeb36681cRevision changes
    • info

      api operation id PostStartMyTimeTrackingV2 was added