Comments API

Comments can be added to and listed as a sub-resource on any resource that supports them. These resources support comments:

They can be listed product-wide, or retrieved from anywhere in the system using the root comments resource.

To reply to a comment, specify the parent_comment_id when creating a comment. The parent must be a top-level comment on the same resource; replies to replies are not supported.

Get a specific comment with a specified set of fields

GET /api/v1/comments/:id

Use the fields parameter to control which attributes are returned.

Parameters
Name	Description
`id *`	Numberic ID of the comment
`fields`	Comma-separated list of fields to include in the response. Use `` to include all default fields. When omitted, a default set of fields is returned. Supported fields: `id`, `body`, `created_at`, `updated_at`, `parent_comment_id`, `user`, `attachments`, `reactions`, `url`, `resource`, and `commentable`. Some fields (for example `created_at`, `updated_at`, and `reactions`) are only returned when named explicitly and are not included by ``.

Example request

GET /api/v1/comments/781701978?fields=body%2Creactions

Example CURL command

curl -g "https://company.aha.io/api/v1/comments/781701978?fields=body%2Creactions" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
contentType: application/json
accept: application/json

Response

Status: 200 OK
contentType: application/json; charset=utf-8

Response body