Developers

Idea Lists

There are many ways ideas can be exciting to users. Recently added ideas help people stay on top of exciting things happening within your Brainstorm. Highly rated ones may attract the attention of those who want to contribute their skills. Here are some ways you can get a list of ideas from the Brainstorm API.

Note, the responses from these API requests do not contain the detailed breakdown of the idea, just some snippets of information. To retrieve a full idea's profile, including comments, parts, tabs, links, and documents, see Idea Profile.

User Ideas

Retrieve a list of ideas that a user is a submitter or team member of.

GET: /api/idea/user?email=[email of user]

Related To

Retrieve a list of ideas that is related to an idea. For example, if idea of id "7" has been tagged with "marketing", then this API will return a list of ideas that also have "marketing" as a tag.

GET: /api/idea/RelatedTo?id=[id of idea profile]

Active Ideas

This API endpoint returns the most active recent ideas in Brainstorm as determined by our activity algorithm.

GET: /api/idea/recentActive

Recent Ideas

This API endpoint returns recently added ideas to Brainstorm, as ordered by the date at which they were submitted.

GET: /api/idea/recent

Highest Rated Ideas

Returns the highest rated ideas in Brainstorm.

GET: /api/idea/highestRated

Sample Response of Idea Lists

This particular response is the /api/idea/recent API call, which orders the response based on when the idea was submitted, in descending order.

This API endpoint is capable of pagination. Note the presence of the following elements:

<NumberOfResults>2</NumberOfResults>
<Page>0</Page>
<TotalResults>59</TotalResults>
    

For more information on paged results, see the Query Strings that manipulate responses section on the API overview page.

<Results xmlns="http://brainstorm.intuit.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Data>
    <Idea>
      <Id>4577</Id>
      <AvgRatingRounded>0</AvgRatingRounded>
      <BusinessUnitName>Consumer: Personal Finance</BusinessUnitName>
      <PunchLine>API Test idea 9/8/2011 4:23:29 PM</PunchLine>
      <ScoreRecent>6.27</ScoreRecent>
      <StatusName>Just an idea, not working on it</StatusName>
      <SubmittedOn>2011-09-08T16:23:29</SubmittedOn>
      <Submitter>
        <Id>50167</Id>
        <DisplayName>Bryant Chou</DisplayName>
        <EmailWork>nunit_ooc@intuitbrainstorm.com</EmailWork>
        <Location/>
        <Phone/>
        <PhotoExists>false</PhotoExists>
        <PhotoUrl_36x36>http://localhost.localhost/Images/photo_none_small.jpg</PhotoUrl_36x36>
      </Submitter>
    </Idea>
    <Idea>
      <Id>4576</Id>
      <AvgRatingRounded>0</AvgRatingRounded>
      <BusinessUnitName>Consumer: Personal Finance</BusinessUnitName>
      <PunchLine>API Test idea 9/8/2011 4:23:29 PM</PunchLine>
      <ScoreRecent>5.38</ScoreRecent>
      <StatusName>Just an idea, not working on it</StatusName>
      <SubmittedOn>2011-09-08T16:23:29</SubmittedOn>
      <Submitter>
        <Id>50167</Id>
        <DisplayName>Bryant Chou</DisplayName>
        <EmailWork>nunit_ooc@intuitbrainstorm.com</EmailWork>
        <Location/>
        <Phone/>
        <PhotoExists>false</PhotoExists>
        <PhotoUrl_36x36>http://localhost.localhost/Images/photo_none_small.jpg</PhotoUrl_36x36>
      </Submitter>
    </Idea>
  </Data>
  <NumberOfResults>2</NumberOfResults>
  <Page>0</Page>
  <TotalResults>50</TotalResults>
</Results>
            
{
   "Data":[
      {
         "Id":4577,
         "AvgRatingRounded":0,
         "BusinessUnitName":"Consumer: Personal Finance",
         "PunchLine":"API Test idea 9\/8\/2011 4:23:29 PM",
         "ScoreRecent":6.27,
         "StatusName":"Just an idea, not working on it",
         "SubmittedOn":"\/Date(1315524209000-0700)\/",
         "Submitter":{
            "Id":50167,
            "DisplayName":"Bryant Chou",
            "EmailWork":"nunit_ooc@intuitbrainstorm.com",
            "Location":"",
            "Phone":"",
            "PhotoExists":false,
            "PhotoUrl_36x36":"http:\/\/localhost.localhost\/Images\/photo_none_small.jpg"
         }
      },
      {
         "Id":4576,
         "AvgRatingRounded":0,
         "BusinessUnitName":"Consumer: Personal Finance",
         "PunchLine":"API Test idea 9\/8\/2011 4:23:29 PM",
         "ScoreRecent":5.38,
         "StatusName":"Just an idea, not working on it",
         "SubmittedOn":"\/Date(1315524209000-0700)\/",
         "Submitter":{
            "Id":50167,
            "DisplayName":"Bryant Chou",
            "EmailWork":"nunit_ooc@intuitbrainstorm.com",
            "Location":"",
            "Phone":"",
            "PhotoExists":false,
            "PhotoUrl_36x36":"http:\/\/localhost.localhost\/Images\/photo_none_small.jpg"
         }
      }
   ],
   "NumberOfResults":2,
   "Page":0,
   "TotalResults":50
}
            

Explaination of pagination elements

  • The <NumberOfResults> value designates how many results are contained in the response.
  • The <Page> value designates how many results were skipped
  • The <TotalResults> value designates how many total results exist.