ts.cmt.list

List comments on an entity.

List comments on an entity.

Requires authentication

Description

Lists comments on a specific entity in chronological order (oldest first). Supports filtering by author and pagination.

Soft-deleted comments appear as placeholders with content replaced by “[deleted]” to preserve thread structure.

Parameters

NameTypeRequiredDefaultDescription
entity_typestringYesEntity type: task, demand, endeavour, artifact, ritual, organization
entity_idstringYesID of the entity
author_idstringFilter by author resource ID
limitinteger50Max results (default: 50)
offsetinteger0Pagination offset

Response

Returns a paginated list of comments.

{
  "comments": [
    {
      "author_id": "res_x1y2z3a4b5c6",
      "content": "First comment",
      "id": "cmt_a1b2c3d4e5f6"
    }
  ],
  "limit": 50,
  "offset": 0,
  "total": 1
}

Errors

CodeDescription
not_authenticatedNo active login for this session
invalid_inputentity_type or entity_id missing

Examples

List task comments

Get all comments on a task.

Request:

{
  "entity_id": "tsk_a1b2c3d4e5f6",
  "entity_type": "task"
}

Response:

{
  "comments": [
    {
      "content": "Looks good!",
      "id": "cmt_a1b2c3d4e5f6"
    }
  ],
  "limit": 50,
  "offset": 0,
  "total": 1
}