List tasks with the ClickUp API
Lists the tasks whose home is a List, up to 100 per page, leaving out closed tasks and subtasks unless asked. Page through with page while last_page in the response is false. Dates are Unix time in milliseconds.
- Identifier
- clickup_list_tasks
The request
POST https://connect.reportei.com/api/tools/clickup_list_tasks/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"list_id": "<list_id>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| list_id | string | Yes | Id of the List, from List lists or List folderless lists. |
| page | integer | No | Page to fetch, starting at 0. |
| order_by | string | No | Field the tasks are ordered by. Defaults to created.Values: id, created, updated, due_date |
| reverse | boolean | No | True to reverse the order. |
| subtasks | boolean | No | True to include subtasks, which are left out by default. |
| statuses | array | No | Status names to filter by, such as to do or in progress, from List spaces. Closed statuses also need include_closed. |
| include_closed | boolean | No | True to include closed tasks, which are left out by default. |
| include_timl | boolean | No | True to include tasks whose home is another List but that were also added to this one. |
| assignees | array | No | User ids to filter by, from the members that List workspaces returns. |
| tags | array | No | Tag names to filter by. |
| due_date_gt | integer | No | Only tasks due after this Unix time in milliseconds. |
| due_date_lt | integer | No | Only tasks due before this Unix time in milliseconds. |
| date_created_gt | integer | No | Only tasks created after this Unix time in milliseconds. |
| date_created_lt | integer | No | Only tasks created before this Unix time in milliseconds. |
| date_updated_gt | integer | No | Only tasks updated after this Unix time in milliseconds. |
| date_updated_lt | integer | No | Only tasks updated before this Unix time in milliseconds. |
| date_done_gt | integer | No | Only tasks done after this Unix time in milliseconds. |
| date_done_lt | integer | No | Only tasks done before this Unix time in milliseconds. |
| include_markdown_description | boolean | No | True to also return each description in Markdown, in markdown_description. |
| archived | boolean | No | Whether to return archived tasks. Defaults to false. |
Supported connections
Your customer connects their ClickUp account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/clickup, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/clickup_list_tasks. It becomes your agent's tool definition with no conversion.
Other ClickUp tools
- List workspacesGETLists the Workspaces (called teams in API v2) that the user authorized for the connection, each with its id and its members. The user ids of the members are the ones the assignee arguments take.
- List spacesGETLists the Spaces of a Workspace, with the task statuses each Space defines. The status names are what the status arguments of the task tools take.
- List foldersGETLists the Folders of a Space. Subfolders come in the same flat list, with parent_folder holding the id of the Folder they sit in.
- List listsGETLists the Lists of a Folder. Lists that sit directly in a Space, outside any Folder, come from List folderless lists.
- List folderless listsGETLists the Lists that sit directly in a Space, outside any Folder.
- Create listPOSTCreates a List in a Folder. Requires name. The List takes the task statuses of its Folder or Space.
- Search tasksGETSearches the tasks of a whole Workspace by date, such as the tasks due this week in every List, up to 100 per page and leaving out closed tasks unless asked. Page through with page until a response brings fewer than 100 tasks. Dates are Unix time in milliseconds.
- Get taskGETReturns a task with its status, assignees, dates, tags, custom field values, checklists and attachments.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
