Aha.io Idea votes API
The Idea votes API from Aha.io — 6 operation(s) for idea votes.
OpenAPI Specification
openapi: 3.1.0
info:
title: Aha! Account backups Idea votes 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 votes
paths:
/api/v1/ideas/{idea_id}/endorsements:
post:
summary: Create an idea vote
description: '"Idea votes" in the web interface are referenced as "idea endorsements" from API endpoints.'
tags:
- Idea votes
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/IdeavotesPostResponse'
example:
idea_endorsement:
id: '6776881149485303077'
idea_id: '58056975'
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
value: '2.0'
link: https://example.com
weight: 1
endorsed_by_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_organization:
id: '138732915'
name: Acme
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/ideas/idea_organizations/138732915
resource: http://company.aha.io/api/v1/idea_organizations/138732915
description:
id: '6776881149495543710'
body: This is a description
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
integration_fields: []
custom_fields: []
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
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IdeavotesPostRequest'
example:
idea_endorsement:
email: no-reply@aha.io
get:
summary: List votes for an idea
description: '"Idea votes" in the web interface are referenced as "idea endorsements" from API endpoints.'
tags:
- Idea votes
parameters:
- name: idea_id
in: path
required: true
schema:
type: string
description: IdeaId identifier
- name: fields
in: query
required: false
schema:
type: string
example: '*,associated_idea_organizations'
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/IdeavotesGetResponse'
example:
idea_endorsements:
- id: '53377392'
idea_id: '58056975'
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
value: null
link: null
weight: 1
endorsed_by_idea_user:
id: '6776881149489779141'
name: user@example.com
email: user@example.com
created_at: '2019-01-01T00:00:00.000Z'
title: null
associated_idea_organizations:
- id: '138732915'
name: Acme
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/ideas/idea_organizations/138732915
resource: http://company.aha.io/api/v1/idea_organizations/138732915
- id: '6776881149495446266'
name: Widgets
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/ideas/idea_organizations/6776881149495446266
resource: http://company.aha.io/api/v1/idea_organizations/6776881149495446266
description:
id: '6776881149484433841'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
integration_fields:
- id: '975466318'
name: key
value: JRA-123
integration_id: 204584239
service_name: jira
created_at: '2019-01-01T00:00:00.000Z'
custom_fields: []
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
pagination:
total_records: 1
total_pages: 1
current_page: 1
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
/api/v1/ideas/{idea_id}/endorsements?multiple_endorsements=true:
post:
summary: Create additional idea votes
description: Create an additional vote for a user who has already voted on the idea. Only permitted for an ideas portal where users are allowed multiple votes on the same idea.
tags:
- Idea votes
parameters:
- name: idea_id
in: path
required: true
schema:
type: string
description: IdeaId identifier
- name: multiple_endorsements
in: query
required: false
schema:
type: string
example: 'true'
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/IdeavotesPostResponse'
example:
idea_endorsement:
id: '6776881149490277785'
idea_id: '140490859'
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
value: null
link: null
weight: 1
endorsed_by_portal_user:
id: '6776881149497726716'
name: no-reply@aha.io
email: no-reply@aha.io
created_at: '2019-01-01T00:00:00.000Z'
endorsed_by_idea_user:
id: '6776881149497315738'
name: no-reply@aha.io
email: no-reply@aha.io
created_at: '2019-01-01T00:00:00.000Z'
title: null
description:
id: ''
body: ''
editor_version: 2
created_at: null
updated_at: null
attachments: []
integration_fields: []
custom_fields: []
idea:
id: '140490859'
reference_num: PRJ1-I-8
name: Some idea name 3
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: '6776881149495006288'
body: ''
editor_version: 2
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-8
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-8
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IdeavotesPostRequest'
example:
idea_endorsement:
email: no-reply@aha.io
/api/v1/ideas/{idea_id}/endorsements?idea_portal_id={idea_portal_id}:
post:
summary: Create an idea vote for a user, using the vote limits of an idea portal
description: '"Idea votes" in the web interface are referenced as "idea endorsements" from API endpoints.'
tags:
- Idea votes
parameters:
- name: idea_id
in: path
required: true
schema:
type: string
description: IdeaId identifier
- name: idea_portal_id
in: path
required: true
schema:
type: string
description: IdeaPortalId identifier
- name: idea_portal_id
in: query
required: false
schema:
type: string
example: '747493361'
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/IdeavotesPostResponse'
example:
idea_endorsement:
id: '6776881149496332684'
idea_id: '140490859'
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
value: null
link: null
weight: 1
endorsed_by_portal_user:
id: '6776881149488700322'
name: no-reply@aha.io
email: no-reply@aha.io
created_at: '2019-01-01T00:00:00.000Z'
endorsed_by_idea_user:
id: '6776881149490328278'
name: no-reply@aha.io
email: no-reply@aha.io
created_at: '2019-01-01T00:00:00.000Z'
title: null
description:
id: ''
body: ''
editor_version: 2
created_at: null
updated_at: null
attachments: []
integration_fields: []
custom_fields: []
idea:
id: '140490859'
reference_num: PRJ1-I-8
name: Some idea name 3
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: '6776881149487885666'
body: ''
editor_version: 2
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-8
resource: http://company.aha.io/api/v1/ideas/PRJ1-I-8
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IdeavotesPostRequest'
example:
idea_endorsement:
email: no-reply@aha.io
idea_portal_id: 747493361
/api/v1/ideas/endorsements:
get:
summary: List votes for an account
description: '"Idea votes" in the web interface are referenced as "idea endorsements" from API endpoints.'
tags:
- Idea votes
parameters: []
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/IdeavotesGetResponse'
example:
idea_endorsements:
- id: '53377392'
idea_id: '58056975'
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
value: null
link: null
weight: 1
endorsed_by_portal_user:
id: '646391926'
name: John Long
email: john@long.com
created_at: '2019-01-01T00:00:00.000Z'
endorsed_by_idea_user:
id: '1056507375'
name: John Long
email: john@long.com
created_at: '2019-01-01T00:00:00.000Z'
title: null
idea_organization:
id: '138732915'
name: Acme
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/ideas/idea_organizations/138732915
resource: http://company.aha.io/api/v1/idea_organizations/138732915
- id: '260764892'
idea_id: '397084149'
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
value: null
link: null
weight: 1
endorsed_by_portal_user:
id: '143214937'
name: Joe Shmo
email: joe@shmo.com
created_at: '2019-01-01T00:00:00.000Z'
endorsed_by_idea_user:
id: '284648642'
name: Joe Shmo
email: joe@shmo.com
created_at: '2019-01-01T00:00:00.000Z'
title: null
- id: '377726308'
idea_id: '245519441'
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
value: null
link: null
weight: 1
endorsed_by_portal_user:
id: '143214937'
name: Joe Shmo
email: joe@shmo.com
created_at: '2019-01-01T00:00:00.000Z'
endorsed_by_idea_user:
id: '284648642'
name: Joe Shmo
email: joe@shmo.com
created_at: '2019-01-01T00:00:00.000Z'
title: null
- id: '449162139'
idea_id: '849214356'
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
value: null
link: null
weight: 1
endorsed_by_portal_user:
id: '646391926'
name: John Long
email: john@long.com
created_at: '2019-01-01T00:00:00.000Z'
endorsed_by_idea_user:
id: '1056507375'
name: John Long
email: john@long.com
created_at: '2019-01-01T00:00:00.000Z'
title: null
idea_organization:
id: '138732915'
name: Acme
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/ideas/idea_organizations/138732915
resource: http://company.aha.io/api/v1/idea_organizations/138732915
- id: '562337269'
idea_id: '140490859'
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
value: null
link: null
weight: 1
endorsed_by_portal_user:
id: '143214937'
name: Joe Shmo
email: joe@shmo.com
created_at: '2019-01-01T00:00:00.000Z'
endorsed_by_idea_user:
id: '284648642'
name: Joe Shmo
email: joe@shmo.com
created_at: '2019-01-01T00:00:00.000Z'
title: null
- id: '1062165688'
idea_id: '444379319'
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
value: null
link: null
weight: 1
endorsed_by_portal_user:
id: '646391926'
name: John Long
email: john@long.com
created_at: '2019-01-01T00:00:00.000Z'
endorsed_by_idea_user:
id: '1056507375'
name: John Long
email: john@long.com
created_at: '2019-01-01T00:00:00.000Z'
title: null
- id: '1071644760'
idea_id: '290908627'
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
value: null
link: null
weight: 1
endorsed_by_portal_user:
id: '143214937'
name: Joe Shmo
email: joe@shmo.com
created_at: '2019-01-01T00:00:00.000Z'
endorsed_by_idea_user:
id: '284648642'
name: Joe Shmo
email: joe@shmo.com
created_at: '2019-01-01T00:00:00.000Z'
title: null
pagination:
total_records: 7
total_pages: 1
current_page: 1
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
/api/v1/ideas/{idea_id}/endorsements?proxy=true:
get:
summary: List only proxy votes for an idea
description: Only returns votes that have an associated organization (proxy votes).
tags:
- Idea votes
parameters:
- name: idea_id
in: path
required: true
schema:
type: string
description: IdeaId identifier
- name: proxy
in: query
required: false
schema:
type: string
example: 'true'
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/IdeavotesGetResponse'
example:
idea_endorsements:
- id: '53377392'
idea_id: '58056975'
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
value: null
link: null
weight: 1
endorsed_by_portal_user:
id: '646391926'
name: John Long
email: john@long.com
created_at: '2019-01-01T00:00:00.000Z'
endorsed_by_idea_user:
id: '1056507375'
name: John Long
email: john@long.com
created_at: '2019-01-01T00:00:00.000Z'
title: null
idea_organization:
id: '138732915'
name: Acme
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/ideas/idea_organizations/138732915
resource: http://company.aha.io/api/v1/idea_organizations/138732915
- id: '6776881149498445225'
idea_id: '58056975'
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
value: null
link: null
weight: 1
endorsed_by_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_organization:
id: '138732915'
name: Acme
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/ideas/idea_organizations/138732915
resource: http://company.aha.io/api/v1/idea_organizations/138732915
pagination:
total_records: 2
total_pages: 1
current_page: 1
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
/api/v1/ideas/{idea_id}/endorsements/{id}:
get:
summary: Get a specific vote for an idea
description: '"Idea votes" in the web interface are referenced as "idea endorsements" from API endpoints.'
tags:
- Idea votes
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:
'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/IdeavotesGetResponse'
example:
idea_endorsement:
id: '53377392'
idea_id: '58056975'
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
value: null
link: null
weight: 1
endorsed_by_portal_user:
id: '646391926'
name: John Long
email: john@long.com
created_at: '2019-01-01T00:00:00.000Z'
endorsed_by_idea_user:
id: '1056507375'
name: John Long
email: john@long.com
created_at: '2019-01-01T00:00:00.000Z'
title: null
idea_organization:
id: '138732915'
name: Acme
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/ideas/idea_organizations/138732915
resource: http://company.aha.io/api/v1/idea_organizations/138732915
idea_users:
- id: '670061655'
first_name: Tim
last_name: Smith
email: tim@smith.com
- id: '1056507375'
first_name: John
last_name: Long
email: john@long.com
description:
id: '6776881149490876559'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
integration_fields:
- id: '975466318'
name: key
value: JRA-123
integration_id: 204584239
service_name: jira
created_at: '2019-01-01T00:00:00.000Z'
custom_fields: []
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
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
put:
summary: Update an idea vote
description: '"Idea votes" in the web interface are referenced as "idea endorsements" from API endpoints.'
tags:
- Idea votes
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:
'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/IdeavotesPutResponse'
example:
idea_endorsement:
id: '53377392'
idea_id: '58056975'
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
value: null
link: null
weight: 1
endorsed_by_portal_user:
id: '646391926'
name: John Long
email: john@long.com
created_at: '2019-01-01T00:00:00.000Z'
endorsed_by_idea_user:
id: '1056507375'
name: John Long
email: john@long.com
created_at: '2019-01-01T00:00:00.000Z'
title: null
idea_organization:
id: '138732915'
name: Acme
created_at: '2019-01-01T00:00:00.000Z'
url: http://company.aha.io/ideas/idea_organizations/138732915
resource: http://company.aha.io/api/v1/idea_organizations/138732915
description:
id: ''
body: ''
editor_version: 2
created_at: null
updated_at: null
attachments: []
integration_fields:
- id: '975466318'
name: key
value: JRA-123
integration_id: 204584239
service_name: jira
created_at: '2019-01-01T00:00:00.000Z'
custom_fields:
- id: '6776881149489855953'
key: vote_priority
name: Priority
updatedAt: '2019-01-01T00:00:00Z'
value: P3
type: string
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
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IdeavotesPostRequest'
example:
idea_endorsement:
value: 123.45
delete:
summa
# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aha/refs/heads/main/openapi/aha-idea-votes-api-openapi.yml