Aha.io Comments API

The Comments API from Aha.io — 12 operation(s) for comments.

OpenAPI Specification

aha-comments-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Aha! Account backups Comments API
  version: 1.0.0
  description: Complete API documentation for Aha! generated from actual test responses
  contact:
    name: Aha! Support
    url: https://www.aha.io/support
servers:
- url: https://{account-domain}.aha.io/api/v1
  description: Aha! API Server
  variables:
    account-domain:
      description: Your Aha! account domain
      default: company
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
tags:
- name: Comments
paths:
  /api/v1/features/{feature_id}/comments:
    post:
      summary: Create a comment on a feature
      description: 'Comments can be added to and listed as a sub-resource on any resource that supports them.

        These resources support comments:


        - [Features](/api/resources/comments/list_comments_on_a_feature)

        - [Epics](/api/resources/comments/list_comments_on_an_epic)

        - [Requirements](/api/resources/comments/list_comments_on_a_requirement)

        - [Ideas](/api/resources/comments/list_comments_on_an_idea)

        - [Initiatives](/api/resources/comments/list_comments_on_an_initiative)

        - [Goals](/api/resources/comments/list_comments_on_a_goal)

        - [Releases](/api/resources/comments/list_comments_on_a_release)

        - [Release phases](/api/resources/comments/list_comments_on_a_release_phase)

        - [To-dos](/api/resources/comments/list_comments_on_a_to-do)


        They can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),

        or retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).'
      tags:
      - Comments
      parameters:
      - name: feature_id
        in: path
        required: true
        schema:
          type: string
        description: FeatureId identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CommentsPostResponse'
              example:
                comment:
                  id: '6776881149488625529'
                  body: <p>This is the comment body for a feature.</p>
                  created_at: '2019-01-01T00:00:00.000Z'
                  updated_at: '2019-01-01T00:00:00.000Z'
                  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: http://company.aha.io/comments/6776881149488625529
                  resource: http://company.aha.io/api/v1/comments/6776881149488625529
                  commentable:
                    type: Feature
                    id: '1007868956'
                    product_id: '131414752'
                    url: http://company.aha.io/features/PRJ1-1
                    resource: http://company.aha.io/api/v1/features/PRJ1-1
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentsPostRequest'
            example:
              comment:
                body: <p>This is the comment body for a feature.</p>
    get:
      summary: List comments on a feature
      description: 'Comments can be added to and listed as a sub-resource on any resource that supports them.

        These resources support comments:


        - [Features](/api/resources/comments/list_comments_on_a_feature)

        - [Epics](/api/resources/comments/list_comments_on_an_epic)

        - [Requirements](/api/resources/comments/list_comments_on_a_requirement)

        - [Ideas](/api/resources/comments/list_comments_on_an_idea)

        - [Initiatives](/api/resources/comments/list_comments_on_an_initiative)

        - [Goals](/api/resources/comments/list_comments_on_a_goal)

        - [Releases](/api/resources/comments/list_comments_on_a_release)

        - [Release phases](/api/resources/comments/list_comments_on_a_release_phase)

        - [To-dos](/api/resources/comments/list_comments_on_a_to-do)


        They can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),

        or retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).'
      tags:
      - Comments
      parameters:
      - name: feature_id
        in: path
        required: true
        schema:
          type: string
        description: FeatureId identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CommentsGetResponse'
              example:
                comments:
                - id: '781701978'
                  body: Comment on feature
                  created_at: '2019-01-01T00:00:00.000Z'
                  updated_at: '2019-01-01T00:00:00.000Z'
                  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:
                  - id: '180276963'
                    download_url: https://company.aha.io/attachments/180276963/token/aaabbbccc9.download?size=original
                    created_at: '2019-01-01T00:00:00.000Z'
                    updated_at: '2019-01-01T00:00:00.000Z'
                    original_file_size: 123
                    content_type: text/plain
                    file_name: uploaded_file_name.txt
                    file_size: 123
                  - id: '822785180'
                    download_url: https://company.aha.io/attachments/822785180/token/aaabbbccc8.download?size=original
                    created_at: '2019-01-01T00:00:00.000Z'
                    updated_at: '2019-01-01T00:00:00.000Z'
                    original_file_size: 123
                    content_type: text/plain
                    file_name: uploaded_file_name.txt
                    file_size: 123
                  url: http://company.aha.io/comments/781701978
                  resource: http://company.aha.io/api/v1/comments/781701978
                  commentable:
                    type: Feature
                    id: '1007868956'
                    product_id: '131414752'
                    url: http://company.aha.io/features/PRJ1-1
                    resource: http://company.aha.io/api/v1/features/PRJ1-1
                pagination:
                  total_records: 1
                  total_pages: 1
                  current_page: 1
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
  /api/v1/epics/{epic_id}/comments:
    post:
      summary: Create a comment on an epic
      description: 'Comments can be added to and listed as a sub-resource on any resource that supports them.

        These resources support comments:


        - [Features](/api/resources/comments/list_comments_on_a_feature)

        - [Epics](/api/resources/comments/list_comments_on_an_epic)

        - [Requirements](/api/resources/comments/list_comments_on_a_requirement)

        - [Ideas](/api/resources/comments/list_comments_on_an_idea)

        - [Initiatives](/api/resources/comments/list_comments_on_an_initiative)

        - [Goals](/api/resources/comments/list_comments_on_a_goal)

        - [Releases](/api/resources/comments/list_comments_on_a_release)

        - [Release phases](/api/resources/comments/list_comments_on_a_release_phase)

        - [To-dos](/api/resources/comments/list_comments_on_a_to-do)


        They can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),

        or retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).'
      tags:
      - Comments
      parameters:
      - name: epic_id
        in: path
        required: true
        schema:
          type: string
        description: EpicId identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CommentsPostResponse'
              example:
                comment:
                  id: '6776881149490456459'
                  body: <p>This is the comment body for an epic.</p>
                  created_at: '2019-01-01T00:00:00.000Z'
                  updated_at: '2019-01-01T00:00:00.000Z'
                  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: http://company.aha.io/comments/6776881149490456459
                  resource: http://company.aha.io/api/v1/comments/6776881149490456459
                  commentable:
                    type: Epic
                    id: '999605892'
                    product_id: '131414752'
                    url: http://company.aha.io/epics/PRJ1-E-1
                    resource: http://company.aha.io/api/v1/epics/PRJ1-E-1
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentsPostRequest'
            example:
              comment:
                body: <p>This is the comment body for an epic.</p>
    get:
      summary: List comments on an epic
      description: 'Comments can be added to and listed as a sub-resource on any resource that supports them.

        These resources support comments:


        - [Features](/api/resources/comments/list_comments_on_a_feature)

        - [Epics](/api/resources/comments/list_comments_on_an_epic)

        - [Requirements](/api/resources/comments/list_comments_on_a_requirement)

        - [Ideas](/api/resources/comments/list_comments_on_an_idea)

        - [Initiatives](/api/resources/comments/list_comments_on_an_initiative)

        - [Goals](/api/resources/comments/list_comments_on_a_goal)

        - [Releases](/api/resources/comments/list_comments_on_a_release)

        - [Release phases](/api/resources/comments/list_comments_on_a_release_phase)

        - [To-dos](/api/resources/comments/list_comments_on_a_to-do)


        They can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),

        or retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).'
      tags:
      - Comments
      parameters:
      - name: epic_id
        in: path
        required: true
        schema:
          type: string
        description: EpicId identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CommentsGetResponse'
              example:
                comments:
                - id: '465979716'
                  body: This is an epic comment
                  created_at: '2019-01-01T00:00:00.000Z'
                  updated_at: '2019-01-01T00:00:00.000Z'
                  user:
                    id: '689956296'
                    name: Henry Humpty
                    email: no-reply@aha.io
                    created_at: '2019-01-01T00:00:00.000Z'
                    updated_at: '2019-01-01T00:00:00.000Z'
                  attachments: []
                  url: http://company.aha.io/comments/465979716
                  resource: http://company.aha.io/api/v1/comments/465979716
                  commentable:
                    type: Epic
                    id: '999605892'
                    product_id: '131414752'
                    url: http://company.aha.io/epics/PRJ1-E-1
                    resource: http://company.aha.io/api/v1/epics/PRJ1-E-1
                pagination:
                  total_records: 1
                  total_pages: 1
                  current_page: 1
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
  /api/v1/requirements/{requirement_id}/comments:
    post:
      summary: Create a comment on a requirement
      description: 'Comments can be added to and listed as a sub-resource on any resource that supports them.

        These resources support comments:


        - [Features](/api/resources/comments/list_comments_on_a_feature)

        - [Epics](/api/resources/comments/list_comments_on_an_epic)

        - [Requirements](/api/resources/comments/list_comments_on_a_requirement)

        - [Ideas](/api/resources/comments/list_comments_on_an_idea)

        - [Initiatives](/api/resources/comments/list_comments_on_an_initiative)

        - [Goals](/api/resources/comments/list_comments_on_a_goal)

        - [Releases](/api/resources/comments/list_comments_on_a_release)

        - [Release phases](/api/resources/comments/list_comments_on_a_release_phase)

        - [To-dos](/api/resources/comments/list_comments_on_a_to-do)


        They can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),

        or retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).'
      tags:
      - Comments
      parameters:
      - name: requirement_id
        in: path
        required: true
        schema:
          type: string
        description: RequirementId identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CommentsPostResponse'
              example:
                comment:
                  id: '6776881149487246030'
                  body: <p>This is the comment body for a requirement.</p>
                  created_at: '2019-01-01T00:00:00.000Z'
                  updated_at: '2019-01-01T00:00:00.000Z'
                  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: http://company.aha.io/comments/6776881149487246030
                  resource: http://company.aha.io/api/v1/comments/6776881149487246030
                  commentable:
                    type: Requirement
                    id: '483368544'
                    product_id: '131414752'
                    url: http://company.aha.io/requirements/PRJ1-1-1
                    resource: http://company.aha.io/api/v1/requirements/PRJ1-1-1
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentsPostRequest'
            example:
              comment:
                body: <p>This is the comment body for a requirement.</p>
    get:
      summary: List comments on a requirement
      description: 'Comments can be added to and listed as a sub-resource on any resource that supports them.

        These resources support comments:


        - [Features](/api/resources/comments/list_comments_on_a_feature)

        - [Epics](/api/resources/comments/list_comments_on_an_epic)

        - [Requirements](/api/resources/comments/list_comments_on_a_requirement)

        - [Ideas](/api/resources/comments/list_comments_on_an_idea)

        - [Initiatives](/api/resources/comments/list_comments_on_an_initiative)

        - [Goals](/api/resources/comments/list_comments_on_a_goal)

        - [Releases](/api/resources/comments/list_comments_on_a_release)

        - [Release phases](/api/resources/comments/list_comments_on_a_release_phase)

        - [To-dos](/api/resources/comments/list_comments_on_a_to-do)


        They can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),

        or retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).'
      tags:
      - Comments
      parameters:
      - name: requirement_id
        in: path
        required: true
        schema:
          type: string
        description: RequirementId identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CommentsGetResponse'
              example:
                comments:
                - id: '971503243'
                  body: This is a requirement comment
                  created_at: '2019-01-01T00:00:00.000Z'
                  updated_at: '2019-01-01T00:00:00.000Z'
                  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: http://company.aha.io/comments/971503243
                  resource: http://company.aha.io/api/v1/comments/971503243
                  commentable:
                    type: Requirement
                    id: '483368544'
                    product_id: '131414752'
                    url: http://company.aha.io/requirements/PRJ1-1-1
                    resource: http://company.aha.io/api/v1/requirements/PRJ1-1-1
                pagination:
                  total_records: 1
                  total_pages: 1
                  current_page: 1
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
  /api/v1/pages/{page_id}/comments:
    post:
      summary: Create a comment on a note
      description: 'Comments can be added to and listed as a sub-resource on any resource that supports them.

        These resources support comments:


        - [Features](/api/resources/comments/list_comments_on_a_feature)

        - [Epics](/api/resources/comments/list_comments_on_an_epic)

        - [Requirements](/api/resources/comments/list_comments_on_a_requirement)

        - [Ideas](/api/resources/comments/list_comments_on_an_idea)

        - [Initiatives](/api/resources/comments/list_comments_on_an_initiative)

        - [Goals](/api/resources/comments/list_comments_on_a_goal)

        - [Releases](/api/resources/comments/list_comments_on_a_release)

        - [Release phases](/api/resources/comments/list_comments_on_a_release_phase)

        - [To-dos](/api/resources/comments/list_comments_on_a_to-do)


        They can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),

        or retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).'
      tags:
      - Comments
      parameters:
      - name: page_id
        in: path
        required: true
        schema:
          type: string
        description: PageId identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CommentsPostResponse'
              example:
                comment:
                  id: '6776881149494267635'
                  body: <p>This is the comment body for a note.</p>
                  created_at: '2019-01-01T00:00:00.000Z'
                  updated_at: '2019-01-01T00:00:00.000Z'
                  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: http://company.aha.io/comments/6776881149494267635
                  resource: http://company.aha.io/api/v1/comments/6776881149494267635
                  commentable:
                    type: Page
                    id: '1051981226'
                    product_id: '131414752'
                    url: http://company.aha.io/pages/PRJ1-N-1
                    resource: http://company.aha.io/api/v1/pages/PRJ1-N-1
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentsPostRequest'
            example:
              comment:
                body: <p>This is the comment body for a note.</p>
    get:
      summary: List comments on a note
      description: 'Comments can be added to and listed as a sub-resource on any resource that supports them.

        These resources support comments:


        - [Features](/api/resources/comments/list_comments_on_a_feature)

        - [Epics](/api/resources/comments/list_comments_on_an_epic)

        - [Requirements](/api/resources/comments/list_comments_on_a_requirement)

        - [Ideas](/api/resources/comments/list_comments_on_an_idea)

        - [Initiatives](/api/resources/comments/list_comments_on_an_initiative)

        - [Goals](/api/resources/comments/list_comments_on_a_goal)

        - [Releases](/api/resources/comments/list_comments_on_a_release)

        - [Release phases](/api/resources/comments/list_comments_on_a_release_phase)

        - [To-dos](/api/resources/comments/list_comments_on_a_to-do)


        They can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),

        or retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).'
      tags:
      - Comments
      parameters:
      - name: page_id
        in: path
        required: true
        schema:
          type: string
        description: PageId identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CommentsGetResponse'
              example:
                comments: []
                pagination:
                  total_records: 0
                  total_pages: 0
                  current_page: 1
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
  /api/v1/ideas/{idea_id}/comments:
    post:
      summary: Create an internal comment for an idea
      description: 'Comments can be added to and listed as a sub-resource on any resource that supports them.

        These resources support comments:


        - [Features](/api/resources/comments/list_comments_on_a_feature)

        - [Epics](/api/resources/comments/list_comments_on_an_epic)

        - [Requirements](/api/resources/comments/list_comments_on_a_requirement)

        - [Ideas](/api/resources/comments/list_comments_on_an_idea)

        - [Initiatives](/api/resources/comments/list_comments_on_an_initiative)

        - [Goals](/api/resources/comments/list_comments_on_a_goal)

        - [Releases](/api/resources/comments/list_comments_on_a_release)

        - [Release phases](/api/resources/comments/list_comments_on_a_release_phase)

        - [To-dos](/api/resources/comments/list_comments_on_a_to-do)


        They can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),

        or retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).'
      tags:
      - Comments
      parameters:
      - name: idea_id
        in: path
        required: true
        schema:
          type: string
        description: IdeaId identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CommentsPostResponse'
              example:
                comment:
                  id: '6776881149495437410'
                  body: <p>This is the comment body for an idea.</p>
                  created_at: '2019-01-01T00:00:00.000Z'
                  updated_at: '2019-01-01T00:00:00.000Z'
                  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: http://company.aha.io/comments/6776881149495437410
                  resource: http://company.aha.io/api/v1/comments/6776881149495437410
                  commentable:
                    type: Ideas::Idea
                    id: '58056975'
                    product_id: '131414752'
                    url: http://company.aha.io/ideas/ideas/PRJ1-I-1
                    resource: http://company.aha.io/api/v1/ideas/ideas/PRJ1-I-1
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentsPostRequest'
            example:
              comment:
                body: <p>This is the comment body for an idea.</p>
    get:
      summary: List comments on an idea
      description: 'Comments can be added to and listed as a sub-resource on any resource that supports them.

        These resources support comments:


        - [Features](/api/resources/comments/list_comments_on_a_feature)

        - [Epics](/api/resources/comments/list_comments_on_an_epic)

        - [Requirements](/api/resources/comments/list_comments_on_a_requirement)

        - [Ideas](/api/resources/comments/list_comments_on_an_idea)

        - [Initiatives](/api/resources/comments/list_comments_on_an_initiative)

        - [Goals](/api/resources/comments/list_comments_on_a_goal)

        - [Releases](/api/resources/comments/list_comments_on_a_release)

        - [Release phases](/api/resources/comments/list_comments_on_a_release_phase)

        - [To-dos](/api/resources/comments/list_comments_on_a_to-do)


        They can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),

        or retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).'
      tags:
      - Comments
      parameters:
      - name: idea_id
        in: path
        required: true
        schema:
          type: string
        description: IdeaId identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CommentsGetResponse'
              example:
                comments: []
                pagination:
                  total_records: 0
                  total_pages: 0
                  current_page: 1
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
  /api/v1/initiatives/{initiative_id}/comments:
    post:
      summary: Create a comment on an initiative
      description: 'Comments can be added to and listed as a sub-resource on any resource that supports them.

        These resources support comments:


        - [Features](/api/resources/comments/list_comments_on_a_feature)

        - [Epics](/api/resources/comments/list_comments_on_an_epic)

        - [Requirements](/api/resources/comments/list_comments_on_a_requirement)

        - [Ideas](/api/resources/comments/list_comments_on_an_idea)

        - [Initiatives](/api/resources/comments/list_comments_on_an_initiative)

        - [Goals](/api/resources/comments/list_comments_on_a_goal)

        - [Releases](/api/resources/comments/list_comments_on_a_release)

        - [Release phases](/api/resources/comments/list_comments_on_a_release_phase)

        - [To-dos](/api/resources/comments/list_comments_on_a_to-do)


        They can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),

        or retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).'
      tags:
      - Comments
      parameters:
      - name: initiative_id
        in: path
        required: true
        schema:
          type: string
        description: InitiativeId identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CommentsPostResponse'
              example:
                comment:
                  id: '6776881149497068301'
                  body: <p>This is the comment body for an initiative.</p>
                  created_at: '2019-01-01T00:00:00.000Z'
                  updated_at: '2019-01-01T00:00:00.000Z'
                  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: http://company.aha.io/comments/6776881149497068301
                  resource: http://company.aha.io/api/v1/comments/6776881149497068301
                  commentable:
                    type: Initiative
                    id: '423077122'
                    product_id: '131414752'
                    url: http://company.aha.io/initiatives/PRJ1-S-1
                    resource: http://company.aha.io/api/v1/initiatives/PRJ1-S-1
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentsPostRequest'
            example:
              comment:
                body: <p>This is the comment body for an initiative.</p>
    get:
      summary: List comments on an initiative
      description: 'Comments can be added to and listed as a sub-resource on any resource that supports them.

        These resourc

# --- truncated at 32 KB (109 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aha/refs/heads/main/openapi/aha-comments-api-openapi.yml