Tasks
Get all tasks
GET v3/projects/23423233/todolists/13964085/taskswill return task for this todolist.
[
{
"ticket": "20842",
"id": 985356917305,
"title": "Task 1",
"description": "Task description",
"start_date": null,
"due_date": null,
"estimated_hours": null,
"estimated_mins": null,
"logged_hours": null,
"logged_mins": null,
"updated_at": "2021-03-22T13:13:46+00:00",
"created_at": "2021-03-22T13:13:46+00:00",
"completed": false,
"assigned": [
8172598588
],
"labels": [
4766001983
],
"sub_tasks": 0,
"rrule": null,
"task_history": null,
"percent_progress": 0,
"attachments": [],
"comments": 0,
"by_me": true,
"template": false,
"form_task": false,
"timesheet_id": null,
"user_stages": [],
"project": {
"id": 4469983073,
"name": "Castle"
},
"creator": {
"id": 7279827447
},
"list": {
"id": 169808767259,
"name": "Test Task List Alpha"
},
"workflow": {
"id": 2747398168,
"name": "Basic workflow"
},
"stage": {
"id": 6074498296,
"name": "New"
},
"custom_fields": [
{
"id": 98734767670,
"title": "Amount",
"description": "",
"type": "Currency",
"extra_info": {
"currency": "custom",
"customValue": "Bh"
},
"value": ""
},
{
"id": 749611238,
"title": "Submit",
"description": "",
"type": "Date",
"value": "2021-08-13"
},
{
"id": 94749807,
"title": "Percentage",
"description": "",
"type": "Percentage",
"value": ""
},
{
"id": 947581945,
"title": "Text field",
"description": "",
"type": "Text",
"value": "999"
}
]
}
]
Get task
GET v3/projects/23423233/todolists/13964085/tasks/13966758will return the specified task.
{
"ticket": "29842",
"id": 175398977305,
"title": "Task 1",
"description": "Task description",
"start_date": null,
"due_date": null,
"estimated_hours": null,
"estimated_mins": null,
"logged_hours": null,
"logged_mins": null,
"updated_at": "2021-03-22T13:13:46+00:00",
"created_at": "2021-03-22T13:13:46+00:00",
"completed": false,
"assigned": [
8172984588
],
"labels": [
4666981713
],
"sub_tasks": 0,
"rrule": null,
"task_history": null,
"percent_progress": 0,
"attachments": [],
"comments": 0,
"by_me": true,
"template": false,
"form_task": false,
"timesheet_id": null,
"user_stages": [],
"project": {
"id": 4769703983,
"name": "Castle"
},
"creator": {
"id": 7277982447
},
"list": {
"id": 168988677259,
"name": "Test Task List Alpha"
},
"workflow": {
"id": 2747329868,
"name": "Basic workflow"
},
"stage": {
"id": 6074498296,
"name": "New"
},
"custom_fields": [
{
"id": 98734767670,
"title": "Amount",
"description": "",
"type": "Currency",
"extra_info": {
"currency": "custom",
"customValue": "Bh"
},
"value": ""
},
{
"id": 749611238,
"title": "Submit",
"description": "",
"type": "Date",
"value": "2021-08-13"
},
{
"id": 94749807,
"title": "Percentage",
"description": "",
"type": "Percentage",
"value": ""
},
{
"id": 947581945,
"title": "Text field",
"description": "",
"type": "Text",
"value": "999"
}
]
}
Create task
-
POST v3/projects/23423233/todolists/13964085/taskswill create a new task from the parameters passed. -
The assigned array is an optional list of people IDs that you can get from the people API.
{
"title": "Get it signed",
"description": "Need to get it signed off immediately",
"start_date": "2016-11-10",
"due_date": "2016-11-10",
"estimated_hours": 5,
"estimated_mins": 30,
"assigned": [
12009183
],
"labels": [
12254912
],
"custom_fields": {
"6768923873": {
"value": "95"
},
"6798922309": {
"value": ["740974745"]
}
}
}
200 OK will be returned along with the JSON of the task (Get task) if the record is added. 403 Forbidden will be returned in case of invalid access. In case of mismatch of allowed values in custom fieds, an error message {"code":2033,"message":"Value of the custom field does not match its type."} will be returned alongwith 200 OK. For adding values in custom fields of type tag or dropdown, an array with multiple or one value is sent respectively.
Attaching files
Attaching files to a task requires id of the attachment. The id is obtained from the Create attachments endpoint, which you must hit first before creating an upload. Multiple attachments are allowed.
{
"title":"Get it signed",
"description":"Need to get it signed off immediately",
"start_date":"2013-12-31",
"due_date":"2013-12-31",
"estimated_hrs":"2",
"attachments":[
{
"id":"123456",
"folder":0
}
],
"assigned":[12009183, 5895623],
"labels":[12254912, 12254913]
}
Update task
PUT v3/projects/23423233/todolists/13964085/tasks/13966758will update the task from the parameters passed.
{
"description":"Get it signed off",
"start_date":"2013-12-31",
"due_date":"2013-12-31",
"custom_fields": {
"6768923873": {
"value": "95"
},
"6798922309": {
"value": ["740974745"]
}
}
}
200 OK will be returned along with the JSON of the task (Get task) if the record is updated. 403 Forbidden will be returned in case of invalid access.
Complete task
PUT v3/projects/23423233/todolists/13964085/tasks/13966758with the following JSON to complete a task. You can passfalseto mark the task as incomplete.
{
"completed":true
}
200 OK will be returned along with the JSON of the task (Get task) if the record is updated. 403 Forbidden will be returned in case of invalid access.
Delete task
DELETE v3/projects/23423233/todolists/13964085/tasks/13966758will delete the task.
204 No Content will be returned if the record is deleted. 403 Forbidden will be returned in case of invalid access.
Get all subtasks
GET v3/projects/23423233/todolists/13964085/tasks/13966758/subtaskswill return all the subtasks for this task.
[
{
"id": 13966722,
"title": "Create a new document for client",
"description": null,
"start_date": "2016-11-15",
"due_date": "2016-11-20",
"estimated_hours": 10,
"estimated_mins": 30,
"logged_hours": null,
"logged_mins": null,
"updated_at": "2016-11-10T11:41:44+00:00",
"created_at": "2016-11-10T11:41:44+00:00",
"completed": false,
"assigned": [
12009183,
11679192
],
"labels": [
12254912
],
"task_history": null,
"percent_progress": 0,
"attachments": [
],
"comments": 0,
"by_me": true,
"template": false,
"project": {
"id": 23423233,
"name": "ProofHub marketing"
},
"creator": {
"id": 12009183
},
"list": {
"id": 13964085,
"name": "Training material on marketing"
}
},
{
"id": 13966759,
"title": "Send the created document to all the people responsible.",
"description": null,
"start_date": null,
"due_date": null,
"estimated_hours": 20,
"estimated_mins": 30,
"logged_hours": 20,
"logged_mins": 30,
"updated_at": "2016-11-10T11:42:58+00:00",
"created_at": "2016-11-10T11:42:58+00:00",
"completed": true,
"assigned": [
],
"labels": [
],
"task_history": "Marked as <i>complete</i> on 10 Nov, 2016 11:52 PM by Chris Wagleys<br>",
"percent_progress": 100,
"completed_at": "2016-11-10T11:52:39+00:00",
"completed_by": 12009183,
"attachments": [
],
"comments": 2,
"by_me": true,
"template": false,
"project": {
"id": 23423233,
"name": "ProofHub marketing"
},
"creator": {
"id": 12009183
},
"list": {
"id": 13964085,
"name": "Training material on marketing"
}
}
]
Get subtask
GET v3/projects/23423233/todolists/13964085/tasks/13966758/subtasks/13966722will return the specified subtask.
{
"id": 13966722,
"title": "Create a new document for client",
"description": null,
"start_date": "2016-11-15",
"due_date": "2016-11-20",
"estimated_hours": 10,
"estimated_mins": 30,
"logged_hours": null,
"logged_mins": null,
"updated_at": "2016-11-10T11:41:44+00:00",
"created_at": "2016-11-10T11:41:44+00:00",
"completed": false,
"assigned": [
12009183,
11679192
],
"labels": [
12254912
],
"task_history": null,
"percent_progress": 0,
"attachments": [
],
"comments": 0,
"by_me": true,
"template": false,
"project": {
"id": 23423233,
"name": "ProofHub marketing"
},
"creator": {
"id": 12009183
},
"list": {
"id": 13964085,
"name": "Training material on marketing"
}
}
Create subtask
-
POST v3/projects/23423233/todolists/13964085/tasks/13966758/subtaskswill create a new subtask from the parameters passed. -
The assigned array is an optional list of people IDs that you can get from the people API.
{
"title": "Get the document ready",
"description": "Document should be ready for the client approval",
"start_date": "2016-11-10",
"due_date": "2016-11-10",
"estimated_hours": 5,
"estimated_mins": 30,
"assigned": [
12009183
],
"labels": [
12254912
]
}
200 OK will be returned along with the JSON of the subtask (Get subtask) if the record is added. 403 Forbidden will be returned in case of invalid access.
Attaching files to a task requires id of the attachment. The id is obtained from the Create attachments endpoint, which you must hit first before creating an upload. Multiple attachments are allowed.
{
"title":"Get it signed",
"description":"Need to get it signed off immediately",
"start_date":"2013-12-31",
"due_date":"2013-12-31",
"estimated_hrs":"2",
"attachments":[
{
"id":"123456"
}
],
"assigned":[12009183, 5895623],
"labels":[12254912, 12254913]
}
Update subtask
PUT v3/projects/23423233/todolists/13964085/tasks/13966758/subtasks/13966722will update the subtask from the parameters passed.
{
"description":"Get it signed off",
"start_date":"2013-12-31",
"due_date":"2013-12-31"
}
200 OK will be returned along with the JSON of the subtask (Get subtask) if the record is updated. 403 Forbidden will be returned in case of invalid access.
Complete subtask
PUT v3/projects/23423233/todolists/13964085/tasks/13966758/subtasks/13966722with the following JSON to complete a subtask. You can passfalseto mark the task as incomplete.
{
"completed":true
}
200 OK will be returned along with the JSON of the subtask (Get subtask) if the record is updated. 403 Forbidden will be returned in case of invalid access.
Delete subtask
DELETE v3/projects/23423233/todolists/13964085/tasks/13966758/subtasks/13966722will delete the subtask.
204 No Content will be returned if the record is deleted. 403 Forbidden will be returned in case of invalid access.
Get all comments
GET v3/projects/23423233/todolists/13964085/tasks/13966758/commentswill return all the comments of specified task.
[
{
"id":30438075,
"description":"Meeting with the client",
"created_at":"2016-11-11T08:11:10+00:00",
"by_me":true,
"comments_count":2,
"list":{
"id":13964085
},
"project":{
"id":23423233
},
"creator":{
"id":12009183
},
"task":{
"id":13966758
}
},
{
"id":30438076,
"description":"Meeting postponed",
"created_at":"2016-11-11T08:15:40+00:00",
"by_me":true,
"comments_count":2,
"list":{
"id":13964085
},
"project":{
"id":23423233
},
"creator":{
"id":12009183
},
"task":{
"id":13966758
}
}
]
Get comment
GET v3/projects/23423233/todolists/13964085/tasks/13966758/comments/30438075will return the specified comment.
{
"id":30438075,
"description":"Meeting with the client",
"created_at":"2016-11-11T08:11:10+00:00",
"by_me":true,
"comments_count":2,
"list":{
"id":13964085
},
"project":{
"id":23423233
},
"creator":{
"id":12009183
},
"task":{
"id":13966758
}
}
Create comment
POST v3/projects/23423233/todolists/13964085/tasks/13966758/commentswill create a new comment in the specified task from the parameters passed.
{
"description":"Call with client"
}
200 OK will be returned along with the JSON of the comment (Get comment) if the record is added. 403 Forbidden will be returned in case of invalid access.
Update comment
PUT v3/projects/23423233/todolists/13964085/tasks/13966758/comments/30438075will update the task comment from the parameters passed.
{
"description":"Call with client"
}
200 OK will be returned along with the JSON of the comment (Get comment) if the record is added. 403 Forbidden will be returned in case of invalid access.
Delete comment
DELETE v3/projects/23423233/todolists/13964085/tasks/13966758/comments/30438075will delete the task comment.
204 No Content will be returned if the record is deleted. 403 Forbidden will be returned in case of invalid access.
Get task history
GET v3/projects/23423233/todolists/13964085/tasks/13966758/historywill return the history of activities happened in task specified.
[
{
"id":31383136,
"user_id":13592923,
"activity":"2017-03-22T10:02:51+00:00",
"date":"2017-03-22",
"action":"Updated"
},
{
"id":31382865,
"user_id":13592923,
"activity":"2017-03-22T10:02:46+00:00",
"date":"2017-03-22",
"action":"Updated"
},
{
"id":31382724,
"user_id":13592923,
"activity":"2017-03-22T10:02:38+00:00",
"date":"2017-03-22",
"action":"Updated"
}
]
Get task history detail
GET v3/projects/23423233/todolists/13964085/tasks/13966758/history/31383136will return the specified activity happened in task specified.
{
"content": "<b>Previous:</b> <br>Time estimate: '0' hours '0' mins <br><br><b>New:</b> <br>Time estimate: '100' hours '0' mins <br><br>"
}
Get all labels
GET v3/labelswill return all the labels.
[
{
"id":12254912,
"name":"Medium",
"color":"#FBB008"
},
{
"id":12254913,
"name":"Low",
"color":"#999999"
},
{
"id":12254914,
"name":"Urgent",
"color":"#FF6600"
},
{
"id":12254915,
"name":"Pending",
"color":"#E07798"
},
{
"id":12254916,
"name":"high",
"color":"#BF0000"
}
]
Get label
GET v3/labels/12254912will return the specified label.
{
"id": 12254912,
"name": "high",
"color": "#BF0000"
}
Create label
POST v3/labelswill create a new label from the parameters passed.
{
"name": "In-progress"
}
200 OK will be returned along with the JSON of the label (Get label) if the record is added. 403 Forbidden will be returned in case of invalid access.
Update label
PUT v3/labels/12254912will update the task from the parameters passed.
{
"name": "high"
}
200 OK will be returned along with the JSON of the label (Get label) if the record is added. 403 Forbidden will be returned in case of invalid access.
Delete label
DELETE v3/labels/12254912will delete the label.
204 No Content will be returned if the record is deleted. 403 Forbidden will be returned in case of invalid access.
Copy task
-
POST v3/projects/23423233/todolists/13964085/tasks/13966758will create a duplicate task from the parameters passed. A task can be copied into same todolist/project or different todolist/project. -
The assigned array is an optional list of people IDs that you can get from the people API.
{
"title":"Copy of one",
"project":23423233,
"list_id":13964085,
"stage":123456,
"copy_assignees":true,
"copy_custom_fields":true,
"copy_dates":true,
"copy_comments":true,
"copy_task":13966758
}
200 OK will be returned along with the JSON of the task (Get task) if the record is added. 403 Forbidden will be returned in case of invalid access.
Move task
-
PUT v3/projects/23423233/todolists/13964085/tasks/13966758will move the selected task from the parameters passed. A task can be moved into different todolist of same or different project. -
The assigned array is an optional list of people IDs that you can get from the people API.
{
"title":"Copy of one",
"project":23423233,
"list_id":13964085,
"stage":123456,
"move_people":true,
"copy_assignees":true,
"copy_custom_fields":true,
"move_dates":true,
"proof_comment":true,
"copy_comments":true,
"completed":false,
"move_task":true,
"id":13966757
}
200 OK will be returned along with the JSON of the task (Get task) if the record is added. 403 Forbidden will be returned in case of invalid access.
Last updated today
Built with Documentation.AI