Skip to main content
Version: 2021-07-28

Get Task Comments

GET 

/projects/tasks/:taskId/comments

Pages comments on a task. Deleted comments are omitted. Replies are returned as sibling rows in comments with parentCommentId set — there is no nested replies array. skip must be a multiple of limit. total counts top-level comments only.

Request​

Version stringrequired

API Version

Available optionsv3
taskId stringrequired

Task id

skip number

Number of top-level comments to skip for paging. Use page offsets only: 0, limit, 2*limit, … (skip must be a multiple of limit). Defaults to 0. Arbitrary offsets (e.g. skip=10&limit=50) return 400.

Possible values: >= 0

Default value:0
limit number

Items per page. Defaults to 50.

Possible values: >= 1 and <= 100

Default value:50
locationId string

Location id. Required for channel: APP. Ignored for OAuth/PIT — those use the location on the auth token. Do not send in path, body, or headers.

application/json

Successful response

Schema
    commentsobject[]required

    Comment rows for this page (top-level and replies flattened)

    totalnumberrequired

    Count of top-level comments (replies are not included in total)

    skipnumber

    Number of top-level comments skipped (echo of the request)

    limitnumber

    Page size (echo of the request)