Ideas

List ideas

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/ideas

Request

  • Base URL
    https://company.aha.io/api/v1
  • Auth
    • OAuth 2
      Authorization codehttps://{account-domain}.aha.io/oauth/authorize
      Token URLhttps://{account-domain}.aha.io/oauth/token
    • or HTTP bearer
    • or API key in cookie session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

pagestring
per_pagestring
qstring
workflow_statusstring
assigned_to_userstring
tagstring
user_idstring
spamstring
created_sincestring
created_beforestring
updated_sincestring
sortstring
fieldsstring

Response

Successful operation

Example response

{
  "ideas": [
    {
      "id": "58056975",
      "name": "Idea 1",
      "product_id": "131414752",
      "votes": 1
    },
    {
      "id": "68691224",
      "name": "Idea 5",
      "product_id": "131414752",
      "votes": 0
    },
    {
      "id": "162120796",
      "name": "Idea 4",
      "product_id": "131414752",
      "votes": 0
    },
    {
      "id": "444379319",
      "name": "Idea 2",
      "product_id": "131414752",
      "votes": 2
    },
    {
      "id": "857675141",
      "name": "Idea 004",
      "product_id": "131414752",
      "votes": 0
    },
    {
      "id": "1055237874",
      "name": "Idea 3 Merged",
      "product_id": "131414752",
      "votes": 2
    }
  ],
  "pagination": {
    "total_records": 6,
    "total_pages": 1,
    "current_page": 1
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.