Developers

Pipeline Lists

There are many ways pipelines can be exciting to users. Recently added pipelines 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 pipelines from the Brainstorm API.

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

User Pipelines

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

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

Active Pipelines

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

GET: /api/pipeline/recentActive

Recent Pipeline

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

GET: /api/pipeline/recent

Sample Response of Pipeline Lists

This particular response is the /api/pipeline/recent API call, which orders the response based on when the pipeline 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>
        <Pipeline>
            <Id>418</Id>
            <IdeaCount>3</IdeaCount>
            <Name>API Test pipeline 9/23/2011 1:39:29 PM</Name>
            <ScoreRecent>6</ScoreRecent>
            <SubmittedOn>2011-09-23T13:39:35</SubmittedOn>
            <Submitter>
                <Id>18003</Id>
                <DisplayName>Dan Jackson</DisplayName>
                <EmailWork>dan_jackson@intuit.com</EmailWork>
                <Location>0102184, Mountain View, CA</Location>
                <Phone/>
                <PhotoExists>false</PhotoExists>
                <PhotoUrl_36x36>http://localhost.localhost/Images/photo_none_small.jpg</PhotoUrl_36x36>
                <Title>SW Engineer 2</Title>
            </Submitter>
        </Pipeline>
        <Pipeline>
            <Id>417</Id>
            <IdeaCount>2</IdeaCount>
            <Name>API Test pipeline 9/23/2011 1:38:41 PM</Name>
            <ScoreRecent>6</ScoreRecent>
            <SubmittedOn>2011-09-23T13:38:41</SubmittedOn>
            <Submitter>
                <Id>18003</Id>
                <DisplayName>Dan Jackson</DisplayName>
                <EmailWork>dan_jackson@intuit.com</EmailWork>
                <Location>0102184, Mountain View, CA</Location>
                <Phone/>
                <PhotoExists>false</PhotoExists>
                <PhotoUrl_36x36>http://localhost.localhost/Images/photo_none_small.jpg</PhotoUrl_36x36>
                <Title>SW Engineer 2</Title>
            </Submitter>
        </Pipeline>
    </Data>
    <NumberOfResults>2</NumberOfResults>
    <Page>0</Page>
    <TotalResults>14</TotalResults>
</Results>
            
{
    "Data": [
        {
            "Id": 418,
            "IdeaCount": 3,
            "Name": "API Test pipeline 9/23/2011 1:39:29 PM",
            "ScoreRecent": 6,
            "SubmittedOn": "/Date(1316810375000-0700)/",
            "Submitter": {
                "Id": 18003,
                "DisplayName": "Dan Jackson",
                "EmailWork": "dan_jackson@intuit.com",
                "Location": "0102184, Mountain View, CA",
                "Phone": "",
                "PhotoExists": false,
                "PhotoUrl_36x36": "http://localhost.localhost/Images/photo_none_small.jpg",
                "Title": "SW Engineer 2"
            }
        },
        {
            "Id": 417,
            "IdeaCount": 2,
            "Name": "API Test pipeline 9/23/2011 1:38:41 PM",
            "ScoreRecent": 6,
            "SubmittedOn": "/Date(1316810321000-0700)/",
            "Submitter": {
                "Id": 18003,
                "DisplayName": "Dan Jackson",
                "EmailWork": "dan_jackson@intuit.com",
                "Location": "0102184, Mountain View, CA",
                "Phone": "",
                "PhotoExists": false,
                "PhotoUrl_36x36": "http://localhost.localhost/Images/photo_none_small.jpg",
                "Title": "SW Engineer 2"
            }
        },
    ],
    "NumberOfResults": 2,
    "Page": 0,
    "TotalResults": 14
}
            

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.