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. The values as they appear in ProdPad are displayed in the "impact_scaled" and "effort_scaled" fields

Filter by a product

Filter by product and tags

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

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": "10", "impact_scaled": "40", "effort": "8", "effort_scaled": "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":[

Notes

Resource Url

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

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

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.

]},{"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

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

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

Was this article helpful?

1 out of 1 found this helpful

Comments

Alexey Vashchenko
February 27, 2017 12:34

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