Actions31
- Agent Actions
- Attachment Actions
- Comment Actions
- Config Actions
- Dartboard Actions
- Doc Actions
- Folder Actions
- Help Center Article Actions
- Skill Actions
- Task Actions
- View Actions
Comment → List Comments
AI-generatedSummary
List comments for a task with optional filters, pagination.
Inputs
- limit — Maximum number of results to return, default 50, range 1‑200
- offset — Zero‑based index to start returning results from, default 0
- task_id (required) — ID of the task whose comments are to be listed
- additionalFields — Collection of filter options such as author, text, published_at ranges, ordering, etc.
Output shape
a list of comment objects
Pagination is applied via limit and offset; response may include only the requested slice and does not wrap items in an envelope.
Examples
Example 1: Retrieve the first 20 comments for task 12345 ordered by newest first
{"resource":"Comment","operation":"List Comments","parameters":{"limit":20,"offset":0,"task_id":"12345","additionalFields":{"o":"-published_at"}}
Example 2: Fetch comments containing a specific author on task 6789 with batching enabled
{"resource":"Comment","operation":"List Comments","parameters":{"limit":50,"offset":0,"task_id":"6789","additionalFields":{"author":"john.doe@example.com"},"requestOptions":{"batching":{"batchSize":25}}}
Example 3: List all comments for a task without pagination limits
{"resource":"Comment","operation":"List Comments","parameters":{"limit":200,"offset":0,"task_id":"98765"}}