Ideas API

When creating an idea where the creator is an idea user we strongly suggest to provide the submitted_idea_portal_id attribute to the idea to ensure that the idea is created in the correct ideas portal and the user gets access to the portal.

If you don't want the idea to be submitted to any portal, you can skip this by setting skip_portal: true in the request body.

Get a specific idea with a specified set of fields

GET /api/v1/ideas/:id

Use the fields parameter to control which attributes are returned.

Parameters
NameDescription
id *

Numeric ID or key of the idea

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, name, reference_num, score, created_at, updated_at, product_id, votes, initial_votes, status_changed_at, workflow_status, description, visibility, portal_restricted, restricted_idea_portal_ids, duplicates, duplicate_of, admin_response, spam, url, resource, product, created_by_user, created_by_portal_user, created_by_idea_user, assigned_to_user, feature, initiative, master_feature, epic, requirement, endorsements_count, subscriptions_count, comments_count, comments, idea_comments, score_facts, tags, full_tags, categories, themes, custom_fields, custom_object_links, record_links, workflow_status_times, submitted_idea_portal, submitted_idea_portal_record_url, portal_visibility, watchers, tasks_count, rank, and integration_fields. Some fields (for example comments, watchers, subscriptions_count, tasks_count, idea_comments, record_links, submitted_idea_portal, and portal_visibility) are only returned when named explicitly and are not included by *.

Example request

GET /api/v1/ideas/PRJ1-I-1?fields=name%2Cvotes

Example CURL command

curl -g "https://company.aha.io/api/v1/ideas/PRJ1-I-1?fields=name%2Cvotes" -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