Query Idea Status Settings for a Node in GraphQL

How to request the current Idea Status settings for a specific node using the GraphQL API.

Aurora's Ideas feature is a great way to leverage your community to generate feedback and suggestions to help your products and services improve over time. These suggestions are tracked within an Idea board using several different status designations.

An Idea Status represents the present state of a user's Idea in the Aurora community. The settings for these statuses are accessible through the GraphQL API and can be set at the node level.

Warning
Only Administrators and Moderators can query or configure these settings.

In this guide, we will provide an example of how to query a specific Idea board for its current Idea Status settings.

To retrieve the idea’s status setting, use this GraphQL query:

{
  board(id:"board:idea1") {
    ... on Idea {
      ideaStatusSettings {
        isIdeaStatusEnabled {
          value
          key
        }
        stopVotesOnClosedIdeas {
          value
          key
        }
        defaultStatusValue {
          value
          key
        }
      }
      ideaStatusProperties {
        isIdeaStatusEnabled
        stopVotesOnClosedIdeas
        defaultStatusValue
      }
    }
  }
}

In this example, we requested a list of values and keys for each of the related fields as well as a simple breakdown of the current properties using the ideaStatusProperties object. Here is a breakdown of the associated fields:

• isIdeaStatusEnabled: If the boolean value is set to true, the idea status feature is turned on for the Idea Board.
• stopVotesOnClosedIdeas: If the boolean value is set to true, voting ends when an Idea is closed.
• defaultStatusValue: The value of this string is the default Idea status value for any new ideas added to the board.

Here is an example response from the API after a successful query:

{
   "data":{
      "board":{
         "ideaStatusSettings":{
            "isIdeaStatusEnabled":{
               "value":true,
               "key":"config.enable_message_status"
            },
            "stopVotesOnClosedIdeas":{
               "value":false,
               "key":"kudos.stop_votes_when_completed"
            },
            "defaultStatusValue":{
               "value":"new",
               "key":"message_status.default_status"
            }
         },
         "ideaStatusProperties":{
            "isIdeaStatusEnabled":true,
            "stopVotesOnClosedIdeas":false,
            "defaultStatusValue":"new"
         }
      }
   }
}