SHshiprush
Comments

Get a specific comment

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

  • Features
  • Epics
  • Requirements
  • Ideas
  • Initiatives
  • Goals
  • Releases
  • Release phases
  • To-dos

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/comments/{id}

Request

  • Base URL
    https://company.aha.io/api/v1
  • Auth
    • OAuth 2
      Authorization codehttps://{account-domain}.aha.io/oauth/authorize
      Token URLhttps://{account-domain}.aha.io/oauth/token
    • or HTTP bearer
    • or API key in cookie session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Id identifier

Query parameters

fieldsstring

Response

Successful operation

Example response

{
  "comments": [
    {
      "id": "55160124",
      "body": "Comment on project",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "parent_comment_id": null,
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [],
      "url": "https://company.aha.io/comments/55160124",
      "resource": "https://company.aha.io/api/v1/comments/55160124",
      "commentable": {
        "type": "Task",
        "id": "748715293",
        "product_id": "131414752",
        "url": "https://company.aha.io/tasks/748715293",
        "resource": "https://company.aha.io/api/v1/tasks/748715293"
      }
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.