List Comments

Keyset-paginated comments on a task, newest first. The first page (no cursor) also carries total; follow meta.next_cursor until it is null. Status moves are GET /tasks/{id}/history.

Deleted comments stay in the feed with an empty body so the client can mark the gap.

GET/api/v1/tasks/{task_id}/comments

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Path parameters

task_idstringrequired

Query parameters

limitinteger

min 1 · max 100 · default: 20

cursorstring | any

opaque keyset cursor from the previous page

Responses

200Successful Response

successboolean

default: true

dataCommentsPage | any

Show properties

Any of:

CommentsPage

commentsComment[]required

Show properties

Array of Comment

idstring

schema_versioninteger

default: 1

entity_typeEntityTyperequired

Allowed:task

entity_idstringrequired

author_idstringrequired

bodystringrequired

mentioned_user_idsstring[]

reactionsobject

created_atstring<date-time>

updated_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

deleted_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

includedUserIncludes

People referenced by the payload, keyed by id — same contract as `CreativeIncludes`. Comment authors, mentions and reactors on the comments feed, transition actors on the history one.

Show properties

usersobject

metaCursorMetarequired

`total` is served on the first page only (no cursor).

Show properties

next_cursorstring | any

Show properties

Any of:

string

string

any

any

totalinteger | any

Show properties

Any of:

integer

integer

any

any

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

422Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X GET "/api/v1/tasks/string/comments" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/tasks/string/comments", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/tasks/string/comments",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "comments": [
      {
        "id": "string",
        "schema_version": 1,
        "entity_type": "task",
        "entity_id": "string",
        "author_id": "string",
        "body": "string",
        "mentioned_user_ids": [
          "string"
        ],
        "reactions": {
          "property1": [
            "string"
          ],
          "property2": [
            "string"
          ]
        },
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z"
      }
    ],
    "included": {
      "users": {
        "property1": {
          "id": "string",
          "name": "string",
          "email": "string",
          "image_url": "string"
        },
        "property2": {
          "id": "string",
          "name": "string",
          "email": "string",
          "image_url": "string"
        }
      }
    },
    "meta": {
      "next_cursor": "string",
      "total": 0
    }
  },
  "message": "string",
  "errors": [
    "string"
  ]
}