Skip to navigation

API · Comments · List comments on a task or other commentable resource

View as Markdown

Fetch all top-level comments for a commentable resource. Filter by object_pk (resource UUID) and content_type (resource family, e.g. task).

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

object_pkstringRequired
UUID of the resource whose comments you want.
content_typeenumRequired

Resource type. Currently task.

Allowed values:
pageintegerOptional

1-based page number.

page_sizeintegerOptional
Results per page.

Response

Paginated list of comments.