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.

List ideas for a product

GET /api/v1/products/:product_id/ideas

Parameters
Name	Description
`product_id *`	Numeric ID or key of the product
`q`	Search term to match against the idea name
`spam`	When true, shows ideas that have been marked as spam. By default, no spam ideas will be shown.
`workflow_status`	When present, filters to ideas with the provided workflow status ID or name.
`sort`	Sorting of the list of ideas. Accepted values are `recent`, `trending`, or `popular`.
`created_before`	UTC timestamp (in ISO8601 format). If provided, only ideas created before the timestamp will be returned.
`created_since`	UTC timestamp (in ISO8601 format). If provided, only ideas created after the timestamp will be returned.
`updated_since`	UTC timestamp (in ISO8601 format). If provided, only ideas updated or created after the timestamp will be returned.
`tag`	String tag value. If provided, only ideas with the associated tag will be returned.
`user_id`	ID of a user. If provided, only ideas created by that user will be returned.
`idea_user_id`	ID of an idea user. If provided, only ideas created by that idea user will be returned.

Example request

GET /api/v1/products/PRJ1/ideas

Example CURL command

curl -g "https://company.aha.io/api/v1/products/PRJ1/ideas" -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