How to Get Threaded Task Comments with the ClickUp API
The ClickUp developer platform lets you retrieve structured conversation data from tasks so you can power integrations, analytics, and internal tools. This how-to explains step by step how to use the Get Threaded Comments endpoint from the ClickUp API reference.
Understanding the ClickUp threaded comments endpoint
The Get Threaded Comments endpoint returns all comments and their replies for a specific task. Results are grouped so that you can see which replies belong to which parent comment.
This endpoint is especially useful when you need to:
- Sync task discussions into another system.
- Build custom reporting on collaboration activity.
- Display ClickUp comment threads inside your own app.
Prerequisites for using the ClickUp API
Before calling the threaded comments endpoint, make sure you have the following in place:
- A ClickUp workspace with at least one task that contains comments.
- A valid ClickUp API token with access to that workspace.
- The task ID for the task whose comments you want to retrieve.
- An HTTP client such as cURL, Postman, or your preferred programming language library.
ClickUp endpoint overview
The endpoint for pulling threaded comments is a standard HTTP GET request. You provide the task ID in the URL path, along with optional query parameters for filtering and pagination.
ClickUp threaded comments HTTP method and path
The request uses the GET method. In the official reference, the pattern is:
GET /api/v2/task/{task_id}/comment/threaded
Replace {task_id} with the actual ID of the task whose conversation you want to read.
Required ClickUp headers
To authenticate and receive JSON data, include these headers in every request:
Authorization: your personal API token or app token.Content-Type: application/json(recommended).
Without a valid authorization header, the ClickUp API returns an error and no comment data.
Core request parameters in ClickUp threaded comments
The threaded comments endpoint supports parameters that define which comments you receive and how they are ordered. Check the official reference for the definitive list, but the most common patterns include:
- task_id (path): the ID of the task whose comments you want to retrieve. This is required.
- page, limit, or equivalent pagination fields: control how many comments are returned in one response and which page of results you fetch.
- optional filters: depending on the current API version, you can often filter by time ranges, users, or other constraints.
When building integrations, always start with a small limit so you can inspect the structure of the ClickUp response before scaling up.
Step-by-step: calling ClickUp threaded comments
The following numbered process walks you through a simple, reliable way to fetch threaded comments.
Step 1: Collect task and workspace information in ClickUp
- Open your ClickUp workspace in the browser.
- Navigate to the space, folder, and list that contains the task you want.
- Open the task and copy its task ID from the URL or task details.
- Verify that the task actually has comments and replies so you can test the response.
Step 2: Generate and store your ClickUp API token
- Sign in to your ClickUp account.
- Navigate to your user or app settings where API tokens are managed.
- Create or copy an existing token with the required permissions.
- Store the token securely in an environment variable or secret manager.
Never hard-code your ClickUp token directly into public code repositories.
Step 3: Compose the ClickUp threaded comments request
Use your task ID to build the request path. For example, with cURL you would create a command like:
curl -X GET
"https://api.clickup.com/api/v2/task/TASK_ID/comment/threaded"
-H "Authorization: YOUR_API_TOKEN"
-H "Content-Type: application/json"
Replace TASK_ID and YOUR_API_TOKEN with your own values from ClickUp. If pagination parameters are supported, append them as query strings.
Step 4: Send the request and inspect the response
After running the request, you should receive a JSON response that contains a collection of parent comments, each with:
- Comment metadata such as ID, text, creator, and timestamps.
- A nested list of replies or child comments attached to that parent.
- Additional properties defined by the ClickUp API version you are using.
Check the structure against the official reference so you understand how to loop through parent comments and their replies in your own code.
Working with ClickUp threaded comments data
Once you have the JSON response, the next step is to parse it and map it into your own data model or interface.
Typical processing flow for ClickUp responses
- Iterate through each parent comment in the returned array.
- Store parent comment details in your database or use them to build UI components.
- For each parent, iterate through the list of replies (child comments).
- Create links between parents and children so you can display discussions as threads.
- Optionally, record user IDs and timestamps for reporting or auditing.
Error handling with the ClickUp API
To keep integrations stable, always implement defensive checks:
- Handle HTTP errors such as 400, 401, 403, or 500 gracefully.
- Log the full response when ClickUp returns an unexpected payload.
- Respect rate limits documented in the API reference to avoid throttling.
- Validate that the task ID exists and is accessible to the token you are using.
Best practices for integrating ClickUp threaded comments
These recommendations help keep your implementation robust and maintainable.
- Cache results when possible: If your application frequently reads the same task comments, cache the ClickUp response to minimize repeated calls.
- Use environment variables: Store tokens and workspace IDs outside your code base.
- Document your mappings: Clearly describe how each field from the ClickUp API maps to your database schema.
- Monitor for schema changes: Periodically compare your assumptions against the official reference page.
Where to learn more about the ClickUp API
For complete field definitions, response examples, and the latest updates, always review the official ClickUp Get Threaded Comments documentation. It includes request examples, response formats, and additional context for advanced use cases.
If you need broader guidance on API strategy, automation, or implementation, you can also explore consulting resources such as Consultevo, which covers integration patterns and optimization approaches that complement what you build on top of ClickUp.
Summary
Using the threaded comments endpoint in the ClickUp API lets you capture rich, structured discussions from tasks. By identifying your task ID, preparing a secure token, composing a proper GET request, and carefully parsing the response, you can embed task conversations in your own systems, build analytics dashboards, or automate workflows that depend on collaboration data.
Need Help With ClickUp?
If you want expert help building, automating, or scaling your ClickUp workspace, work with ConsultEvo — trusted ClickUp Solution Partners.
“`
