Get Task

Nothing Found

Help Center
API Feature Requests

Nothing Found

Get Task

View information about a task. You can only view task information of tasks you can access.

Tasks with attachments will return an "attachments" response.

SecurityAuthorization Token

Request

path Parameters

task_id

required

string

query Parameters

custom_task_ids	boolean If you want to reference a task by its custom task id, this value must be `true`.
team_id	number <double> Only used when the `custom_task_ids` parameter is set to `true`. For example: `custom_task_ids=true&team_id=123`.
include_subtasks	boolean Include subtasks, default false
include_markdown_description	boolean To return task descriptions in Markdown format, use `?include_markdown_description=true`.

Responses

200

get/task/{task_id}

Request samples

Response samples

application/json

{"id": "string",
"custom_id": "string",
"custom_item_id": 0,
"name": "string",
"text_content": "string",
"description": "string",
"status": {"status": "in progress",
"color": "#d3d3d3",
"orderindex": 1,
"type": "custom"
},
"orderindex": "string",
"date_created": "string",
"date_updated": "string",
"date_closed": "string",
"creator": {"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": ["string"
],
"watchers": ["string"
],
"checklists": ["string"
],
"tags": ["string"
],
"parent": "string",
"priority": "string",
"due_date": "string",
"start_date": "string",
"time_estimate": "string",
"time_spent": "string",
"custom_fields": [{"id": "string",
"name": "string",
"type": "string",
"type_config": { },
"date_created": "string",
"hide_from_guests": true,
"value": {"id": 183,
"username": "John Doe",
"email": "john@example.com",
"color": "#7b68ee",
"initials": "JD",
"profilePicture": null
},
"required": true
}
],
"list": {"id": "123"
},
"folder": {"id": "456"
},
"space": {"id": "789"
},
"url": "string",
"markdown_description": "string",
"attachments": [{"id": "62447c77-2086-4cda-b274-f53eccf0547b.csv",
"date": 1711570108374,
"title": "Canny - Exported posts - 2024-03-09.csv",
"type": 1,
"source": 1,
"version": 0,
"extension": "csv",
"thumbnail_small": null,
"thumbnail_medium": null,
"thumbnail_large": null,
"is_folder": null,
"mimetype": "text/csv",
"hidden": false,
"parent_id": "36fjfqy",
"size": 140970,
"total_comments": 0,
"resolved_comments": 0,
"user": [{"id": [{"type": "integer",
"contentEncoding": "int32"
}
],
"username": {"type": "string"
},
"initials": {"type": "string"
},
"email": {"type": "string"
},
"color": {"type": "string"
},
"profilePicture": {"type": "string"
}
}
],
"deleted": false,
"orientation": null,
"url": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv",
"email_data": null,
"url_w_query": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv?view=open",
"url_w_host": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv"
}
]
}

© 2022 ClickUp
Security
Your Privacy
Terms