Starts a new time tracking for a user.

POST

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

Required Permissions: The user must be an admin or the creator.

Path parameters

userIdstringRequired

The id of the user. Not required if the me route is used.

Request

This endpoint expects an object.

typeOfWorkIdstringRequired

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

timezonestringRequired>=1 character

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

isBillablebooleanOptional

Whether the time tracking is billable or not.

isBilledbooleanOptional

Whether the time tracking is billed or not.

taskIdstringOptional

The id of the task.

projectIdstringOptional

The id of the project.

notestringOptional

The note of the time tracking.

Response

timezonestring>=1 character

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

typeOfWorkIdstring

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.

taskIdstringOptional

The id of the task.

projectIdstringOptional

The id of the project.

notestringOptional

The note of the time tracking.

startDateUtcdatetimeOptional

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

startTimeUtcstringOptional

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

endDateUtcdatetimeOptional

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

endTimeUtcstringOptional

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.

startDateLocaldatetimeOptional

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

startTimeLocalstringOptional

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

endDateLocaldatetimeOptional

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

endTimeLocalstringOptional

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.

durationintegerOptional

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

breakDurationintegerOptional

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

userIdstringOptional

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

idstringOptional

The id of the time tracking.

createdBystringOptional

The id of the user who created this time tracking.

createdOndatetimeOptional

The date this time tracking was created.

updatedBystringOptional

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

updatedOndatetimeOptional

The date this time tracking was last modified.

typeOfWorkobjectOptional

userobjectOptional

taskobjectOptional

projectobjectOptional

breakslist of objectsOptional

The breaks of the time tracking.

resourceVersionlongOptional

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

POST

1 curl -X POST https://api.awork.com/api/v1/users/userId/timetracking/start \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
6   "timezone": "Europe/London"
7 }'

200Successful

1 {
2   "timezone": "Europe/Berlin",
3   "typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
4   "isBillable": true,
5   "isBilled": false,
6   "taskId": "123e4567-e89b-12d3-a456-426614174000",
7   "projectId": "123e4567-e89b-12d3-a456-426614174000",
8   "note": "I created a first draft for the new sitemap",
9   "startDateUtc": "2022-03-01T00:00:00Z",
10   "startTimeUtc": "09:21:00",
11   "endDateUtc": "2022-03-01T18:21:05Z",
12   "endTimeUtc": "11:45:00",
13   "startDateLocal": "2022-03-01T00:00:00Z",
14   "startTimeLocal": "10:21:00",
15   "endDateLocal": "2022-03-01T17:21:05Z",
16   "endTimeLocal": "12:45:00",
17   "duration": 8635,
18   "breakDuration": 1,
19   "userId": "123e4567-e89b-12d3-a456-426614174000",
20   "id": "123e4567-e89b-12d3-a456-426614174000",
21   "createdBy": "123e4567-e89b-12d3-a456-426614174000",
22   "createdOn": "2024-01-15T09:30:00Z",
23   "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
24   "updatedOn": "2024-01-15T09:30:00Z",
25   "typeOfWork": {
26     "id": "123e4567-e89b-12d3-a456-426614174000",
27     "name": "name",
28     "icon": "icon",
29     "isArchived": true
30   },
31   "user": {
32     "id": "123e4567-e89b-12d3-a456-426614174000",
33     "firstName": "firstName",
34     "lastName": "lastName",
35     "hasImage": true,
36     "isExternal": true,
37     "tags": [
38       {
39         "id": "123e4567-e89b-12d3-a456-426614174000"
40       }
41     ],
42     "teams": [
43       {
44         "id": "123e4567-e89b-12d3-a456-426614174000"
45       }
46     ]
47   },
48   "task": {
49     "id": "123e4567-e89b-12d3-a456-426614174000",
50     "name": "name",
51     "baseType": "projecttask",
52     "taskStatusId": "123e4567-e89b-12d3-a456-426614174000",
53     "typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
54     "project": {
55       "id": "123e4567-e89b-12d3-a456-426614174000",
56       "name": "name",
57       "projectStatus": {
58         "id": "123e4567-e89b-12d3-a456-426614174000"
59       },
60       "company": {
61         "id": "123e4567-e89b-12d3-a456-426614174000"
62       },
63       "projectType": {
64         "id": "123e4567-e89b-12d3-a456-426614174000"
65       },
66       "isPrivate": false,
67       "hasImage": true,
68       "isExternal": true,
69       "isBillableByDefault": true,
70       "createdBy": "123e4567-e89b-12d3-a456-426614174000",
71       "tags": [
72         {
73           "id": "123e4567-e89b-12d3-a456-426614174000"
74         }
75       ],
76       "teams": [
77         {
78           "id": "123e4567-e89b-12d3-a456-426614174000"
79         }
80       ]
81     },
82     "projectId": "123e4567-e89b-12d3-a456-426614174000",
83     "plannedDuration": 21600,
84     "closedOn": "2024-01-15T09:30:00Z",
85     "taskStatus": {
86       "id": "123e4567-e89b-12d3-a456-426614174000",
87       "name": "name",
88       "description": "description",
89       "type": "type",
90       "order": 1.1,
91       "icon": "icon"
92     },
93     "createdBy": "123e4567-e89b-12d3-a456-426614174000",
94     "correlationId": "123e4567-e89b-12d3-a456-426614174000",
95     "parentId": "123e4567-e89b-12d3-a456-426614174000",
96     "parentTask": {
97       "id": "123e4567-e89b-12d3-a456-426614174000",
98       "name": "name"
99     },
100     "assignees": [
101       {
102         "id": "123e4567-e89b-12d3-a456-426614174000"
103       }
104     ],
105     "tags": [
106       {
107         "id": "123e4567-e89b-12d3-a456-426614174000"
108       }
109     ]
110   },
111   "project": {
112     "id": "123e4567-e89b-12d3-a456-426614174000",
113     "name": "name",
114     "projectStatus": {
115       "id": "123e4567-e89b-12d3-a456-426614174000",
116       "name": "name",
117       "description": "description",
118       "type": "type",
119       "isArchived": true
120     },
121     "company": {
122       "id": "123e4567-e89b-12d3-a456-426614174000",
123       "name": "name",
124       "hasImage": true,
125       "description": "description"
126     },
127     "projectType": {
128       "id": "123e4567-e89b-12d3-a456-426614174000",
129       "name": "name",
130       "icon": "icon",
131       "isArchived": true
132     },
133     "isPrivate": false,
134     "hasImage": true,
135     "isExternal": true,
136     "isBillableByDefault": true,
137     "createdBy": "123e4567-e89b-12d3-a456-426614174000",
138     "tags": [
139       {
140         "id": "123e4567-e89b-12d3-a456-426614174000"
141       }
142     ],
143     "teams": [
144       {
145         "id": "123e4567-e89b-12d3-a456-426614174000"
146       }
147     ]
148   },
149   "breaks": [
150     {
151       "startDate": "2022-01-01T12:00:00Z",
152       "duration": 3600,
153       "endDate": "2022-01-01T13:00:00Z"
154     }
155   ],
156   "resourceVersion": 637825154598057900,
157   "isExternal": true
158 }

Stops the currently running time tracking of the specified user.

Up Next

Built with

1	curl -X POST https://api.awork.com/api/v1/users/userId/timetracking/start \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
6	"timezone": "Europe/London"
7	}'

1	{
2	"timezone": "Europe/Berlin",
3	"typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
4	"isBillable": true,
5	"isBilled": false,
6	"taskId": "123e4567-e89b-12d3-a456-426614174000",
7	"projectId": "123e4567-e89b-12d3-a456-426614174000",
8	"note": "I created a first draft for the new sitemap",
9	"startDateUtc": "2022-03-01T00:00:00Z",
10	"startTimeUtc": "09:21:00",
11	"endDateUtc": "2022-03-01T18:21:05Z",
12	"endTimeUtc": "11:45:00",
13	"startDateLocal": "2022-03-01T00:00:00Z",
14	"startTimeLocal": "10:21:00",
15	"endDateLocal": "2022-03-01T17:21:05Z",
16	"endTimeLocal": "12:45:00",
17	"duration": 8635,
18	"breakDuration": 1,
19	"userId": "123e4567-e89b-12d3-a456-426614174000",
20	"id": "123e4567-e89b-12d3-a456-426614174000",
21	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
22	"createdOn": "2024-01-15T09:30:00Z",
23	"updatedBy": "123e4567-e89b-12d3-a456-426614174000",
24	"updatedOn": "2024-01-15T09:30:00Z",
25	"typeOfWork": {
26	"id": "123e4567-e89b-12d3-a456-426614174000",
27	"name": "name",
28	"icon": "icon",
29	"isArchived": true
30	},
31	"user": {
32	"id": "123e4567-e89b-12d3-a456-426614174000",
33	"firstName": "firstName",
34	"lastName": "lastName",
35	"hasImage": true,
36	"isExternal": true,
37	"tags": [
38	{
39	"id": "123e4567-e89b-12d3-a456-426614174000"
40	}
41	],
42	"teams": [
43	{
44	"id": "123e4567-e89b-12d3-a456-426614174000"
45	}
46	]
47	},
48	"task": {
49	"id": "123e4567-e89b-12d3-a456-426614174000",
50	"name": "name",
51	"baseType": "projecttask",
52	"taskStatusId": "123e4567-e89b-12d3-a456-426614174000",
53	"typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
54	"project": {
55	"id": "123e4567-e89b-12d3-a456-426614174000",
56	"name": "name",
57	"projectStatus": {
58	"id": "123e4567-e89b-12d3-a456-426614174000"
59	},
60	"company": {
61	"id": "123e4567-e89b-12d3-a456-426614174000"
62	},
63	"projectType": {
64	"id": "123e4567-e89b-12d3-a456-426614174000"
65	},
66	"isPrivate": false,
67	"hasImage": true,
68	"isExternal": true,
69	"isBillableByDefault": true,
70	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
71	"tags": [
72	{
73	"id": "123e4567-e89b-12d3-a456-426614174000"
74	}
75	],
76	"teams": [
77	{
78	"id": "123e4567-e89b-12d3-a456-426614174000"
79	}
80	]
81	},
82	"projectId": "123e4567-e89b-12d3-a456-426614174000",
83	"plannedDuration": 21600,
84	"closedOn": "2024-01-15T09:30:00Z",
85	"taskStatus": {
86	"id": "123e4567-e89b-12d3-a456-426614174000",
87	"name": "name",
88	"description": "description",
89	"type": "type",
90	"order": 1.1,
91	"icon": "icon"
92	},
93	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
94	"correlationId": "123e4567-e89b-12d3-a456-426614174000",
95	"parentId": "123e4567-e89b-12d3-a456-426614174000",
96	"parentTask": {
97	"id": "123e4567-e89b-12d3-a456-426614174000",
98	"name": "name"
99	},
100	"assignees": [
101	{
102	"id": "123e4567-e89b-12d3-a456-426614174000"
103	}
104	],
105	"tags": [
106	{
107	"id": "123e4567-e89b-12d3-a456-426614174000"
108	}
109	]
110	},
111	"project": {
112	"id": "123e4567-e89b-12d3-a456-426614174000",
113	"name": "name",
114	"projectStatus": {
115	"id": "123e4567-e89b-12d3-a456-426614174000",
116	"name": "name",
117	"description": "description",
118	"type": "type",
119	"isArchived": true
120	},
121	"company": {
122	"id": "123e4567-e89b-12d3-a456-426614174000",
123	"name": "name",
124	"hasImage": true,
125	"description": "description"
126	},
127	"projectType": {
128	"id": "123e4567-e89b-12d3-a456-426614174000",
129	"name": "name",
130	"icon": "icon",
131	"isArchived": true
132	},
133	"isPrivate": false,
134	"hasImage": true,
135	"isExternal": true,
136	"isBillableByDefault": true,
137	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
138	"tags": [
139	{
140	"id": "123e4567-e89b-12d3-a456-426614174000"
141	}
142	],
143	"teams": [
144	{
145	"id": "123e4567-e89b-12d3-a456-426614174000"
146	}
147	]
148	},
149	"breaks": [
150	{
151	"startDate": "2022-01-01T12:00:00Z",
152	"duration": 3600,
153	"endDate": "2022-01-01T13:00:00Z"
154	}
155	],
156	"resourceVersion": 637825154598057900,
157	"isExternal": true
158	}