Search tasks with the ClickUp API

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

Identifier
clickup_search_tasks

The request

POST https://connect.reportei.com/api/tools/clickup_search_tasks/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "team_id": "<team_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

ParameterTypeRequiredDescription
team_idstringYesId of the Workspace, from List workspaces.
pageintegerNoPage to fetch, starting at 0.
order_bystringNoField the tasks are ordered by. Defaults to created.Values: id, created, updated, due_date
reversebooleanNoTrue to reverse the order.
subtasksbooleanNoTrue to include subtasks, which are left out by default.
include_closedbooleanNoTrue to include closed tasks, which are left out by default.
parentstringNoId of a task, from List tasks or Search tasks, to return only its subtasks.
due_date_gtintegerNoOnly tasks due after this Unix time in milliseconds.
due_date_ltintegerNoOnly tasks due before this Unix time in milliseconds.
date_created_gtintegerNoOnly tasks created after this Unix time in milliseconds.
date_created_ltintegerNoOnly tasks created before this Unix time in milliseconds.
date_updated_gtintegerNoOnly tasks updated after this Unix time in milliseconds.
date_updated_ltintegerNoOnly tasks updated before this Unix time in milliseconds.
date_done_gtintegerNoOnly tasks done after this Unix time in milliseconds.
date_done_ltintegerNoOnly tasks done before this Unix time in milliseconds.
include_markdown_descriptionbooleanNoTrue to also return each description in Markdown, in markdown_description.

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_search_tasks. It becomes your agent's tool definition with no conversion.

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.