GET /ideas

Retrieves a list of ideas associated to an account. The account is determined by the API key.

  • Pagination is done using “page” parameter.
  • The amount of results returned for each page can be set by the “size” parameter.

Resource URL

GET https://api.prodpad.com/v1/ideas

Parameters

apikey required If the apikey parameter is missing or incorrect a 401 error will be returned
page optional The amount of results returned for each page can be set by the “size” parameter.
tags optional URL encoded comma separated list of tag names. The available tags can be fetched using GET /tags endpoint
product optional URL encoded name of a product for the account. The available products can be fetched using GET /products endpoint
persona optional URL encoded name of a persona for the account. The available personas can be fetched using GET /personas endpoint
status optional URL encode status for the account. The available statuses can be fetched from using GET /statuses endpoint
by_project_id optional Retrieves the data using the project id instead of the unique id. The project id is the one seen in the UI.
state optional

"active", "active_public" and "archived". "active" returns active ideas, "active_public" returns the ideas that are marked as visible on portal and "archived" returns archived ideas.

If the parameter is not specified then the default will return both active and active_visible like the UI.

 

Response

{
 
success”:true
 
idea_count : 126,
 
page”: 1,
 
size : 20,
 
ideas”: [
   
{
     
id : 1155,
     
project_id”: 181,
     
account”: {
         
id”: 2
         
slug”:”slug”,
         
name”:“some name
     
},
     
web_url”:”https:\/\/app.prodpad.com\/company\/slug\/idea\/181\/show”,
     
impact : Unknown”,
     
effort : Unknown”,
     
created_at : 2012-05-09 17:00:49”,
     
updated_at : 2012-11-26 14:52:08”,
     
title : An idea”,
     
description : A description of the idea”,
     
state : active
     
creator : {
       
id : 3”,
       
username : username”,
       
display_name : Bill Mahon
     
},
   
},…
 
]
}

Notes:

  • Impact and Effort fields will return the value for the currently choosen scale e.g. If the scale has been set to Tee-shirt sizes then impact/effort will show XS, L etc. The default scale is modified fibonnaci.
  • All dates are in UTC
  • State can be active or archived
  • Only active ideas are returned
  • The text fields can include HTML markup

Examples:

Filter by tags

https://api.prodpad.com/v1/ideas?tags=tag1,tag2&apikey=somekey

Filter by a product

https://api.prodpad.com/v1/ideas?product=my+product&apikey=somekey

Filter by product and tags

https://api.prodpad.com/v1/ideas?product=my+product&tags=tag1,tag2&apikey=somekey

 



Retrieves an individual idea. The account is determined by the API key

This method returns standard set of data and can be set to return extended information using the expand parameter.
The extended information is:

  • List of comments associated to the idea
  • List of user stories associated to the idea
  • List of external links associated to the idea
  • List of roadmap cards the idea has been associated to
  • List of votes for the idea
  • List of associated mockups
  • List of associated files

Resource Url

GET https://api.prodpad.com/v1/ideas/:id

Parameters

apikey required If the apikey parameter is missing or incorrect a 401 error will be returned
expand optional returns additional information for the idea. See list above

Response

Status: 200 OK
{
       
"id" : 1155,
       
"project_id": 181,
       
"account": {
               
"id": "2"
               
"slug":"acme-ltd",
               
"name":"Acme Ltd."
       
},
       
"web_url":"https:\/\/app.prodpad.com\/company\/acme-ltd\/idea\/181\/show",
       
"impact" : "40",
       
"effort" : "13",
       
"created_at" : "2012-05-09 17:00:49",
       
"updated_at" : "2012-11-26 14:52:08",
       
"title" : "Suggest new music",
       
"description" : "Create a new module that recommends new tunes or albums to users",
       
"state" : "active",
       
"business_case": {
               
"problem" : "Too many people get bored of their music",
               
"value" : "Implementing this idea will increase engagement with new music"
       
},
       
"functional_spec" : "",
       
"notes" : ""
       
"creator" : {
               
"id" : "3",
               
"username" : "bill-mahon",
               
"display_name" : "Bill Mahon"
       
},
       
"status" : {
               
"id" : "32",
               
"status" : "Queued for Dev",
               
"added" : "2014-05-18 22:00:38"
       
},
       
"owner" : {
               
"id" : "3",
               
"username" : "bill-mahon",
               
"display_name" : "Bill Mahon"
       
},
       
"author" : {
               
"id" : "3",
               
"username" : "bill-mahon",
               
"display_name" : "Bill Mahon"
       
},
       
"tags" : [
       
{
           
"id": "270",
           
"tag": "innovation",
           
"added_at": "2014-05-19 22:21:59"
       
}
   
],
   
"products" : [
       
{
           
"id": "25",
           
"name": "MusicApp3000",
           
"added": "2014-05-19 22:22:35"
       
},
       
{
           
"id": "27",
           
"name": "MusicApp for Android",
           
"added": "2014-05-19 22:22:03"
       
}
   
],
   
"personas" : [
       
{
           
"id": "23",
           
"name": "Me",
           
"added": "2014-05-19 22:22:09"
       
}
   
],
   
"comments" : [
       
{
           
"id": "1517",
           
"comment": "Sure, I can see how this would add value...",
           
"created_by": {
               
"id": "1",
               
"username": "john-doe",
               
"display_name": "John Doe"
           
},
           
"created_at": "2014-05-19 20:31:55",
           
"vote": {
               
"id": "6",
               
"vote": "yea",
               
"added_at": "2014-05-19 20:31:55"
           
},
           
"replies": [

           
]
       
},
       
{
           
"id": "1518",
           
"comment": "Let's see what comes back from the design team.",
           
"created_by": {
               
"id": "4",
               
"username": "duncano",
               
"display_name": "Duncan O'Goddard"
           
},
           
"created_at": "2014-05-19 22:37:45",
           
"replies": [
               
{
                   
"id": "1519",
                   
"comment": "I'm working on some great mockups... I'll add them here soon!",
                   
"created_by": {
                       
"id": "9",
                       
"username": "rhonda-allen",
                       
"display_name": "Rhonda Allen"
                   
},
                   
"created_at": "2014-05-19 22:37:53",
                   
"updated_at": "2014-05-19 22:37:53"
               
}
           
]
       
},
   
],
   
"user_stories" : [
       
{
           
"id": "8425",
"title": "Fast learning",
"story": "As a user,
I want to access new music suggestions, So that I never get bored of listening to the same songs",
"acceptance_criteria": "* Display a list of recommended songs based on behavior
* User can play songs or browse through albums by swiping",
           
"created_at": "2014-05-19 22:48:55",
           
"updated_at": "2014-05-19 22:48:55"
       
},
   
],
   
"external_links" : [
       
{
           
"id": "107",
           
"external_id": "5941189",
           
"title": "UserVoice Suggestion - Suggest new music based on preferences",
           
"url": "http:\/\/acme-ltd.uservoice.com\/forums\/748181-general\/suggestions\/4115989-suggest-new-music",
           
"created_at": "2014-05-18 17:19:12"
       
}
   
],
   
"roadmap_cards" : [
       
{
           
"id": "10",
           
"title": "Music discovery",
           
"description": "A series of enhancements to make music discovery on our app much better.",
           
"column": {
               
"id": "65",
               
"title": "Near term",
               
"column_number": "2"
           
},
           
"roadmap": {
               
"id": "49"
           
}
       
}
   
],
   
"votes" : {
       
"yea": [
           
{
               
"id": "6",
               
"voter": {
                   
"id": "3",
                   
"username": "bill-mahon",
                   
"display_name": "Bill Mahon"
               
},
               
"created_at": "2014-05-19 20:31:55"
           
}
       
],
       
"nay": [

       
],
       
"maybe": [

       
]
   
},
   
"mockups" : [
       
{
           
"id": "168",
           
"name": "music-recommendations-mockup-001.png"
           
"previous_versions": [

           
]
       
},
       
{
           
"id": "165",
           
"name": "album-recommendations-mockup-002.png",
           
"previous_versions": [
               
{
                   
"id": "166",
                   
"name": "album-recommendations-mockup-001.png",
                   
"version": 1
               
}
           
]
       
}
   
],
   
"files": [
       
{
           
"id": "69",
           
"name": "sales-pitch-doc.ppt",
       
}
   
]
}

Notes

  • All date and time is returned in UTC

Fetches the user stories associated to the idea.

Resource Url

GET https://api.prodpad.com/v1/ideas/:id/userstories

Parameters

apikey required If the apikey parameter is missing or incorrect a 401 error will be returned

Response

Status: 200 OK
[
   
{
       
"id": "8425",
"title":"Fast learning",
       
"story": "As a user,
I want to access new music suggestions,
So that I never get bored of listening to the same songs"
,
       
"acceptance_criteria": "* Display a list of recommended songs based on behavior
* User can play songs or browse through albums by swiping"
,
       
"created_at": "2014-05-19 22:48:55",
       
"updated_at": "2014-05-19 22:48:55"
   
},
]

Notes

  • All date and time is returned in UTC
  • The text fields can include HTML markup

Fetches the comments for an idea. The comments are ordered by asscending date. If a comment was made when adding a status or voting the related object will be include for the comment. If a mockup is associated to the idea then any comments for that mockup will also be included in the response.

Resource Url

GET https://api.prodpad.com/v1/ideas/:id/comments

Parameters

apikey required If the apikey parameter is missing or incorrect a 401 error will be returned

Response

Status: 200 OK
[
   
{
       
"id": "1500",
       
"comment": "I think we should reduce the copy here",
       
"created_by": {
           
"id": "4",
           
"username": "duncano",
           
"display_name": "Duncan O'Goddard"
       
},
       
"created_at": "2013-07-09 15:06:26",
       
"mockup": {
           
"id": "165",
           
"name": "music-recommendations-mockup-001.jpg",
       
},
       
"replies": [

       
]
   
},
   
{
       
"id": "1517",
       
"comment": "Yep, I agree",
       
"created_by": {
           
"id": "9",
           
"username": "kjameson",
           
"display_name": "Kara Jameson"
       
},
       
"created_at": "2014-05-19 20:31:55",
       
"vote": {
           
"id": "6",
           
"vote": "yea",
           
"added_at": "2014-05-19 20:31:55"
       
},
       
"replies": [

       
]
   
},
   
{
       
"id": "1518",
       
"comment": "Let's see what comes back from the design team.",
       
"created_by": {
           
"id": "4",
           
"username": "duncano",
           
"display_name": "Duncan O'Goddard"
       
},
       
"created_at": "2014-05-19 22:37:45",
       
"replies": [
           
{
               
"id": "1519",
               
"comment": "I'm working on some great mockups... I'll add them here soon!",
               
"created_by": {
                   
"id": "9",
                   
"username": "rhonda-allen",
                   
"display_name": "Rhonda Allen"
               
},
               
"created_at": "2014-05-19 22:37:53",
               
"updated_at": "2014-05-19 22:37:53"
           
}
       
]
   
},
   
{
       
"id": "1519",
       
"comment": "I'd like to see something a little more colorful",
       
"created_by": {
           
"id": "6",
           
"username": "john-doe",
           
"display_name": "John Doe"
       
},
       
"created_at": "2014-05-19 22:37:53",
       
"replies": [

       
]
   
}
]

Notes

  • All date and time is returned in UTC
  • The text fields can include HTML markup
Fetches the votes for an idea. Each returned vote object will include the comment made when the vote was cast. The response splits the votes into yea, nay and maybe arrays.

Resource Url

GET https://api.prodpad.com/v1/ideas/:id/votes

Parameters

apikey required If the apikey parameter is missing or incorrect a 401 error will be returned

Response

Status: 200 OK
{
   
"yea": [
       
{
           
"id": "6",
           
"voter": {
               
"id": "1",
               
"username": "john-doe",
               
"display_name": "John Doe"
           
},
           
"comments": {
               
"id": "1517",
               
"comment" : "Sure, I can see how this would add value..."
           
},
           
"created_at": "2014-05-19 20:31:55"
       
}
   
],
   
"nay": [

   
],
   
"maybe": [

   
]
}

Notes

  • All date and time is returned in UTC
  • The text fields can include HTML markup
Have more questions? Submit a request

Comments

  • Avatar
    Alexey Vashchenko

    Huge amount of issues in this acryicle:
    1) Not valid json: wrong "" are used, "," missed in some places. Any json validation tool will show this json is not valid
    2) Expand parameter not explained for Get ideas/id. Using expand sometimes return valid result, sometimes server respond with 404

Powered by Zendesk