Time entries

8 endpoints at a glance

Method	Path	Summary
POST	/tasks/{task_id}/timer/start	Start Timer
POST	/tasks/{task_id}/timer/stop	Stop Timer
POST	/time-entries	Create Manual
DELETE	/time-entries/{entry_id}	Delete Entry
PATCH	/time-entries/{entry_id}	Update Entry
GET	/time-entries/for-task	List For Task
GET	/time-entries/running	Get Running
GET	/time-entries/totals/project/{project_id}	Project Totals

time-entries

---

Get Running

GET

/time-entries/running

The user's currently-running timer, or {entry: null}.

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/time-entries/running

Playground

Headers

authorization

Samples

---

List For Task

GET

/time-entries/for-task

Parameters

Header Parameters

authorization

Query Parameters

task_id*

Type

string

Required

page

Type

integer

Default

1

limit

Type

integer

Default

100

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/time-entries/for-task

Playground

Headers

authorization

Variables

Key

Value

task_id*

page

limit

Samples

---

Project Totals

GET

/time-entries/totals/project/{project_id}

Per-user time totals for a project (used by the Time tab).

Parameters

Header Parameters

authorization

Path Parameters

project_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/time-entries/totals/project/{project_id}

Playground

Headers

authorization

Variables

Key

Value

project_id*

Samples

---

Create Manual

POST

/time-entries

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"task_id": "string",

  

"started_at": "string",

  

"ended_at": "string",

  

"notes": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/time-entries

Playground

Headers

authorization

Body

Samples

---

Delete Entry

DELETE

/time-entries/{entry_id}

Parameters

Header Parameters

authorization

Path Parameters

entry_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/time-entries/{entry_id}

Playground

Headers

authorization

Variables

Key

Value

entry_id*

Samples

---

Update Entry

PATCH

/time-entries/{entry_id}

Parameters

Header Parameters

authorization

Path Parameters

entry_id*

Type

string

Required

Request Body

application/json

{

  

"started_at": "string",

  

"ended_at": "string",

  

"notes": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/time-entries/{entry_id}

Playground

Headers

authorization

Variables

Key

Value

entry_id*

Body

Samples

---

Start Timer

POST

/tasks/{task_id}/timer/start

Parameters

Header Parameters

authorization

Path Parameters

task_id*

Type

string

Required

Request Body

application/json

{

  

"notes": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/tasks/{task_id}/timer/start

Playground

Headers

authorization

Variables

Key

Value

task_id*

Body

Samples

---

Stop Timer

POST

/tasks/{task_id}/timer/stop

Stop the running timer on this task (if it's the user's).

Returns the stopped entry. 404 if no running timer is on this task.

Parameters

Header Parameters

authorization

Path Parameters

task_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/tasks/{task_id}/timer/stop

Playground

Headers

authorization

Variables

Key

Value

task_id*

Samples

---