API v1 ReferenceTime Tracking

Stops the currently running time tracking of the specified user.

The request body is optional. You can provide a stopReason to indicate how the tracking was stopped. For external API clients, the stopReason is automatically set to "external-api" regardless of what is provided. For this operation to work there must be a running time tracking for the user. <Check title="Required Permissions" icon="key">The user must be an admin or the creator.</Check>

Authentication

AuthorizationBearer

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

Path parameters

userIdstringRequiredformat: "uuid"
The id of the user.

Request

This endpoint expects an object.

Response

OK
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).