List task comments with the ClickUp API

Lists the comments of a task, newest first, 25 per call. For the next page, send the date and the id of the last comment received in start and start_id.

Identifier
clickup_list_task_comments

The request

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "task_id": "<task_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
task_idstringYesId of the task, from List tasks or Search tasks, or its custom task id when custom_task_ids is true.
custom_task_idsbooleanNoTrue when task_id is a custom task id, such as DEV-42, the custom_id that List tasks returns. Requires team_id.
team_idintegerNoId of the Workspace, from List workspaces, which returns it as text: send it as a number. Needed only with custom_task_ids.
startintegerNoThe date of the last comment of the previous call, in Unix milliseconds. Goes with start_id.
start_idstringNoThe id of the last comment of the previous call to List task comments. Goes with start.

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

Other ClickUp tools

See all 14 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

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