Aha.io Idea comments API
The Idea comments API from Aha.io — 3 operation(s) for idea comments.
OpenAPI Specification
openapi: 3.1.0
info:
title: Aha! Account backups Idea 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: Idea comments
paths:
/api/v1/ideas/{idea_id}/idea_comments:
post:
summary: Create an idea comment for an idea
description: 'Idea comments can appear in ideas portals.
To reply to an idea_comment, specify the parent_idea_comment_id. Its visibility
will come from its parent idea comment and cannot be overridden.'
tags:
- Idea 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/IdeacommentsPostResponse'
example:
idea_comment:
id: '6776881149497092049'
idea_id: '58056975'
body: <p>This is the comment body.</p>
created_at: '2019-01-01T00:00:00.000Z'
visibility: Visible to all ideas portal users
parent_idea_comment_id: null
idea_commenter_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'
idea:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1
attachments: []
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IdeacommentsPostRequest'
example:
idea_comment:
idea_id: PRJ1-I-1
body: <p>This is the comment body.</p>
get:
summary: List idea comments for an idea
description: 'Idea comments can appear in ideas portals.
To reply to an idea_comment, specify the parent_idea_comment_id. Its visibility
will come from its parent idea comment and cannot be overridden.'
tags:
- Idea 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/IdeacommentsGetResponse'
example:
idea_comments:
- id: '622085811'
idea_id: '58056975'
body: This is a great idea! We'll get started right away.
created_at: '2019-01-01T00:00:00.000Z'
visibility: Visible to all ideas portal users
parent_idea_comment_id: null
idea_commenter_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'
idea:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1
attachments: []
- id: '6776881149487056351'
idea_id: '58056975'
body: A reply to a comment
created_at: '2019-01-01T00:00:00.000Z'
visibility: Visible to all ideas portal users
parent_idea_comment_id: 622085811
idea_commenter_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'
idea:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1
attachments: []
- id: '6776881149491301288'
idea_id: '58056975'
body: Just us employees
created_at: '2019-01-01T00:00:00.000Z'
visibility: Visible to creator and employees
parent_idea_comment_id: null
idea_commenter_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'
idea:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1
attachments: []
pagination:
total_records: 3
total_pages: 1
current_page: 1
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
/api/v1/idea_comments/{id}:
put:
summary: Mark an idea comment as spam
description: 'Idea comments can appear in ideas portals.
To reply to an idea_comment, specify the parent_idea_comment_id. Its visibility
will come from its parent idea comment and cannot be overridden.'
tags:
- Idea comments
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Id 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/IdeacommentsPutResponse'
example:
idea_comment:
id: '622085811'
idea_id: '58056975'
body: <p>Updated comment body.</p>
created_at: '2019-01-01T00:00:00.000Z'
visibility: Visible to all ideas portal users
parent_idea_comment_id: null
idea_commenter_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'
idea:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1
attachments: []
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IdeacommentsPostRequest'
example:
idea_comment:
spam: 'true'
/api/v1/ideas/{idea_id}/idea_comments/{id}:
delete:
summary: Delete an idea comment
description: 'Idea comments can appear in ideas portals.
To reply to an idea_comment, specify the parent_idea_comment_id. Its visibility
will come from its parent idea comment and cannot be overridden.'
tags:
- Idea comments
parameters:
- name: idea_id
in: path
required: true
schema:
type: string
description: IdeaId identifier
- name: id
in: path
required: true
schema:
type: string
description: Id identifier
responses:
'204':
description: No content - operation successful
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
components:
schemas:
IdeacommentsPostRequest:
type: object
properties:
idea_comment:
type: object
properties:
spam:
type: string
example: 'true'
example:
spam: 'true'
example:
idea_comment:
spam: 'true'
IdeacommentsGetResponse:
type: object
properties:
idea_comments:
type: array
items:
type: object
properties:
id:
type: string
example: '622085811'
idea_id:
type: string
example: '58056975'
body:
type: string
example: This is a great idea! We'll get started right away.
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
visibility:
type: string
example: Visible to all ideas portal users
parent_idea_comment_id:
type: 'null'
idea_commenter_user:
type: object
properties:
id:
type: string
name:
type: string
email:
type: string
created_at:
type: string
updated_at:
type: string
example:
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'
idea:
type: object
properties:
id:
type: string
reference_num:
type: string
name:
type: string
created_at:
type: string
updated_at:
type: string
workflow_status:
type: string
description:
type: string
url:
type: string
resource:
type: string
example:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1
attachments:
type: array
items: {}
example:
id: '622085811'
idea_id: '58056975'
body: This is a great idea! We'll get started right away.
created_at: '2019-01-01T00:00:00.000Z'
visibility: Visible to all ideas portal users
parent_idea_comment_id: null
idea_commenter_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'
idea:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1
attachments: []
example:
- id: '622085811'
idea_id: '58056975'
body: This is a great idea! We'll get started right away.
created_at: '2019-01-01T00:00:00.000Z'
visibility: Visible to all ideas portal users
parent_idea_comment_id: null
idea_commenter_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'
idea:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1
attachments: []
- id: '6776881149487056351'
idea_id: '58056975'
body: A reply to a comment
created_at: '2019-01-01T00:00:00.000Z'
visibility: Visible to all ideas portal users
parent_idea_comment_id: 622085811
idea_commenter_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'
idea:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1
attachments: []
- id: '6776881149491301288'
idea_id: '58056975'
body: Just us employees
created_at: '2019-01-01T00:00:00.000Z'
visibility: Visible to creator and employees
parent_idea_comment_id: null
idea_commenter_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'
idea:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1
attachments: []
pagination:
type: object
properties:
total_records:
type: integer
example: 3
total_pages:
type: integer
example: 1
current_page:
type: integer
example: 1
example:
total_records: 3
total_pages: 1
current_page: 1
example:
idea_comments:
- id: '622085811'
idea_id: '58056975'
body: This is a great idea! We'll get started right away.
created_at: '2019-01-01T00:00:00.000Z'
visibility: Visible to all ideas portal users
parent_idea_comment_id: null
idea_commenter_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'
idea:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1
attachments: []
- id: '6776881149487056351'
idea_id: '58056975'
body: A reply to a comment
created_at: '2019-01-01T00:00:00.000Z'
visibility: Visible to all ideas portal users
parent_idea_comment_id: 622085811
idea_commenter_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'
idea:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1
attachments: []
- id: '6776881149491301288'
idea_id: '58056975'
body: Just us employees
created_at: '2019-01-01T00:00:00.000Z'
visibility: Visible to creator and employees
parent_idea_comment_id: null
idea_commenter_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'
idea:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1
attachments: []
pagination:
total_records: 3
total_pages: 1
current_page: 1
IdeacommentsPutResponse:
type: object
properties:
idea_comment:
type: object
properties:
id:
type: string
example: '622085811'
idea_id:
type: string
example: '58056975'
body:
type: string
example: <p>Updated comment body.</p>
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
visibility:
type: string
example: Visible to all ideas portal users
parent_idea_comment_id:
type: 'null'
idea_commenter_user:
type: object
properties:
id:
type: string
example: '1020675218'
name:
type: string
example: Mary Humpty
email:
type: string
example: no-reply@aha.io
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
example:
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'
idea:
type: object
properties:
id:
type: string
example: '58056975'
reference_num:
type: string
example: PRJ1-I-1
name:
type: string
example: Idea 1
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
workflow_status:
type: object
properties:
id:
type: string
name:
type: string
position:
type: string
complete:
type: string
color:
type: string
example:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
type: object
properties:
id:
type: string
body:
type: string
editor_version:
type: string
created_at:
type: string
updated_at:
type: string
attachments:
type: string
example:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url:
type: string
example: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource:
type: string
example: http://company.aha.io/api/v1/ideas/PRJ1-I-1
example:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1
attachments:
type: array
items: {}
example:
id: '622085811'
idea_id: '58056975'
body: <p>Updated comment body.</p>
created_at: '2019-01-01T00:00:00.000Z'
visibility: Visible to all ideas portal users
parent_idea_comment_id: null
idea_commenter_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'
idea:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
position: 1
complete: false
color: '#dce7c6'
description:
id: '103757394'
body: Description of idea 1
editor_version: 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
url: http://company.aha.io/ideas/ideas/PRJ1-I-1
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1
attachments: []
example:
idea_comment:
id: '622085811'
idea_id: '58056975'
body: <p>Updated comment body.</p>
created_at: '2019-01-01T00:00:00.000Z'
visibility: Visible to all ideas portal users
parent_idea_comment_id: null
idea_commenter_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'
idea:
id: '58056975'
reference_num: PRJ1-I-1
name: Idea 1
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
workflow_status:
id: '3259216'
name: New
# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aha/refs/heads/main/openapi/aha-idea-comments-api-openapi.yml