GET /products

Fetches a list of products associated to the account. The account is determined by the API key.

If there are product lines the products will be grouped together in their productline. If there are no product lines or some products are not in a product line are grouped together under products array in the response.

Resource URL

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

Parameters

apikey required If the apikey parameter is missing or incorrect a 401 error will be returned
group optional returns the products grouped by productline. Use true for the value of the parameter

Response

 

[
   
{
       
"id": "27",
       
"name": "MusicApp3000",
       
"description": "An awesome music app that makes users lives better",
       
"roadmaps": {
           
"id": "50"
       
},
       
"order": "0",
       
"created_at": "2012-11-07 20:55:07"
   
},
   
{
       
"id": "25",
       
"name": "MusicApp for Android",
       
"description": "The mobile app version of the MusicApp3000. It isn't a mobile replica of the MusicApp3000 but reflects the key use cases on mobile",
       
"order": "1",
       
"roadmaps": {
           
"id": "49"
       
},
       
"created_at": "2012-10-02 12:05:12"
   
},
   
{
       
"id": "34",
       
"name": "MusicApp desktop",
       
"description": "A downloadable widget that allows artists to publish straight to MusicApp3000.",
       
"order" : "0",
       
"roadmaps": {
           
"id": "54"
       
},
       
"created_at": "2013-02-12 19:38:53",
       
"updated_at": "2014-05-06 12:27:33"
   
},
   
{
       
"id": "33",
       
"name": "MusicApp4000",
       
"description": "The latest secret version of our music app, for internal use only",
       
"order" : "1",
       
"roadmaps": {
           
"id": "53"
       
},
       
"created_at": "2013-01-28 19:01:05",
       
"updated_at": "2014-04-12 13:04:37"
   
}
]


With the group parameter

Status: 200 OK
{
   
"productlines": [
       
{
           
"id": "1",
           
"name": "Cloud Products",
           
"created_at": "2014-04-12 13:04:27",
           
"products": [
               
{
                   
"id": "27",
                   
"name": "MusicApp3000",
                   
"description": "An awesome music app that makes users lives better",
                   
"roadmaps": {
                       
"id": "50"
                   
},
                   
"order": "0",
                   
"created_at": "2012-11-07 20:55:07"
               
},
               
{
                   
"id": "25",
                   
"name": "MusicApp for Android",
                   
"description": "The mobile app version of the MusicApp3000. It isn't a mobile replica of the MusicApp3000 but reflects the key use cases on mobile",
                   
"order": "1",
                   
"roadmaps": {
                       
"id": "49"
                   
},
                   
"created_at": "2012-10-02 12:05:12"
               
}
           
]
       
}
   
],
   
"products": [
       
{
           
"id": "34",
           
"name": "MusicApp desktop",
           
"description": "A downloadable widget that allows artists to publish straight to MusicApp3000.",
           
"roadmaps": {
               
"id": "54"
           
},
           
"created_at": "2013-02-12 19:38:53",
           
"updated_at": "2014-05-06 12:27:33"
       
},
       
{
           
"id": "33",
           
"name": "MusicApp4000",
           
"description": "The latest secret version of our music app, for internal use only",
           
"roadmaps": {
               
"id": "53"
           
},
           
"created_at": "2013-01-28 19:01:05",
           
"updated_at": "2014-04-12 13:04:37"
       
}
   
],
   
"product_count": "4"
}

 

Notes:

  • All dates are in UTC
  • The text fields can include HTML markup

 

Retrieves the product canvas and documentation for a product

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 mockups associated with the product
  • List of personas assocaited with the product
  • List of fileas associated with the product

Resource Url

GET https://api.prodpad.com/v1/products/: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": "25",
   
"name": "MusicApp3000",
   
"description": "MusicApp3000 is the premiere music playing app of its time.",
   
"vision": "The vision is that we improve the world by producing a music product that works and makes people's lives better.",
   
"kpis": "* Daily activity\r\n* More KPIs\r\n* Conversion rate",
   
"documentation": "We will follow a strategy that delivers the vision",
   
"created_at": "2012-10-02 12:05:12",
   
"updated_at": "2013-06-22 12:09:46"
}

With expand parameter

Status: 200 OK
{
   
"id": "25",
   
"name": "MusicApp3000",
   
"description": "MusicApp3000 is the premiere music playing app of its time.",
   
"vision": "The vision is that we improve the world by producing a music product that works and makes people's lives better.",
   
"kpis": "* Daily activity\r\n* More KPIs\r\n* Conversion rate",
   
"documentation": "We will follow a strategy that delivers the vision",
   
"created_at": "2012-10-02 12:05:12",
   
"updated_at": "2013-06-22 12:09:46",
   
"mockups": [
       
{
           
"id": "168",
           
"name": "onboarding_flow.png",
           
"url": "https:\/\/d3mrwhp27xg56v.cloudfront.net\/9f70c02f99800521.png",
           
"version": 1,
           
"previous_versions": [

           
]
       
},
       
{
           
"id": "165",
           
"name": "tutorial-002.png",
           
"url": "https:\/\/d3mrwhp27xg56v.cloudfront.net\/145ffd555698cd6fa603d1e6.jpg",
           
"version": 2,
           
"previous_versions": [
               
{
                   
"id": "166",
                   
"name": "tutorial-001.png",
                   
"url": "https:\/\/d3mrwhp27xg56v.cloudfront.net\/aaa21507e169cfe45c3f71a140187c.png",
                   
"version": 1
               
}
           
]
       
},
       
{
           
"id": "163",
           
"name": "Signup Page Mockup",
           
"url": "https:\/\/www.dropbox.com\/s\/ostuecckljvry3\/signup_page.png",
           
"version": 1,
           
"previous_versions": [

           
]
       
}
   
],
   
"personas": [
       
{
           
"id": "23",
           
"name": "Bigglesworth the Buyer",
           
"description": "Bigglesworth is a picky buyer, only shelling out if he's really convinced by the ROI.",
           
"image": {
               
"original": "https:\/\/d2657two4gl0a2.cloudfront.net\/a2c560f13b9ab9084af804a6ba9677c306.png"
           
},
           
"created_at": "2012-05-23 16:07:11",
           
"updated_at": "2013-02-02 21:58:50"
       
},
       
{
           
"id": "30",
           
"name": "Hilfast Quadram",
           
"description": "Hilfast is an enthusiastic chap who loves hearing great tunes on the go!",
           
"image": {
               
"original": "https:\/\/d38984ubc7u16c.cloudfront.net\/images\/persona-pic-default.jpg"
           
},
           
"created_at": "2012-11-24 14:20:44",
           
"updated_at": "2012-11-24 14:29:50"
       
},
   
],
   
"files": [
       
{
           
"id": "56",
           
"name": Music Trends Outlook 2017",
            "
url": "https:\/\/docs.google.com\/a\/acme-ltd.com\/spreadsheet\/ccc?key=0Ag_5m_VdFCb3VVNd2FteDvLF9b3BraUE&output=html&chrome=false&widget=true",
            "
created_at": "2014-04-15 18:04:01"
        },
        {
            "
id": "57",
            "
name": "Market Analysis.ppt",
            "
url": https:\/\/docs.google.com\/a\/acme-ltd.com\/spreadsheet\/ccc?key=0Ag_5m_VDvLF9teVldFVVVlCNd2FBraUE&output=html&chrome=false&widget=true,
            "
created_at": "2014-04-15 18:04:02"
        }
    ]
}

Notes

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

Retrieves the roadmap for a product. This is an alias for GET /roadmaps/:id

Resource Url

GET https://api.prodpad.com/v1/products/:id/roadmaps

Parameters

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

Response

Status: 200 OK
[
   
{
       
"id": "139",
       
"title": "Current",
       
"products": {
           
"id": "49"
       
},
       
"column_number": "1",
       
"roadmap_cards": [
           
{
               
"id": "52",
               
"title": "Google Maps integration",
               
"description": "Include an interative map of the location of listings, integrated with Google Maps and linking to street view. Release 1.1",
               
"public": "public",
               
"position": "0",
               
"pipeline": {
                   
"ideas": {
                       
"id": "66799",
                       
"title": "Google Chrome extension ",
                       
"description": "How about a Google Chrome extension so that people can view their status while on any page that they're browsing?",
                       
"state": "active",
                       
"status": {
                           
"id": "981",
                           
"status": "QA"
                       
},
                       
"added": "2014-05-02 17:59:22",
                       
"order": "0"
                   
},
                   
"specs": [

                   
]
               
},
               
"tags": [
                   
{
                       
"id": "6020",
                       
"tag": "integration",
                       
"added": "2013-10-31 15:04:16"
                   
},
                   
{
                       
"id": "267",
                       
"tag": "data\/analytics",
                       
"added": "2014-04-14 19:32:29"
                   
}
               
]
           
},
           
{
               
"id": "49",
               
"title": "Single Sign On",
               
"description": "",
               
"public": "public",
               
"position": "1",
               
"pipeline": {
                   
"ideas": {
                       
"id": "10015",
                       
"title": "",
                       
"description": "Cannot delete a tag (from Settings>>Tags).  \n\nTo test\/reproduce, try to delete the FIRST tag named 'integration'.  We need to be able to remove this one.",
                       
"state": "active",
                       
"status": [

                       
],
                       
"added": "2014-02-27 11:25:40",
                       
"order": "2"
                   
},
                   
"specs": {
                       
"id": "102201",
                       
"story": "serch on desc",
                       
"acceptance_criteria": "",
                       
"added": "2013-11-11 10:51:19",
                       
"order": "1"
                   
}
               
},
               
"tags": [

               
]
           
},
       
],
       
"created_at": "2013-02-03 02:53:51",
       
"updated_at": "2014-02-07 09:06:26"
   
},
   
{
       
"id": "140",
       
"title": "Near term",
       
"products": {
           
"id": "49"
       
},
       
"column_number": "2",
       
"roadmap_cards": [
           
{
               
"id": "54",
               
"title": "Advanced list management",
               
"description": "Provide a section for landlords and estate agents to manage their listings and viewings.",
               
"public": "private",
               
"position": "0",
               
"pipeline": {
                   
"ideas": {
                       
"id": "47586",
                       
"title": "",
                       
"description": "Can I have a download option?",
                       
"state": "active",
                       
"status": [

                       
],
                       
"added": "2014-01-26 14:47:02",
                       
"order": "2"
                   
},
                   
"specs": {
                       
"id": "112770",
                       
"story": "As Larry Landlord I want to add photos to listings already in my profile In order to make it easier to have great listings.",
                       
"acceptance_criteria": "",
                       
"added": "2014-05-21 15:55:04",
                       
"order": "3"
                   
}
               
},
               
"tags": [
                   
{
                       
"id": "266",
                       
"tag": "listing quality",
                       
"added": "2013-10-31 14:17:51"
                   
},
                   
{
                       
"id": "291",
                       
"tag": "engagement",
                       
"added": "2013-12-04 18:51:52"
                   
}
               
]
           
},
           
{
               
"id": "53",
               
"title": "Home page redesign",
               
"description": "Following the release of the search function, redo the homepage to focus on search capabilities.",
               
"public": "private",
               
"position": "1",
               
"pipeline": {
                   
"ideas": {
                       
"id": "28413",
                       
"title": "",
                       
"description": "Just for fun (and usability): Make use of a right click functional in the browser.\n\nPossible applications:\n- On Mockups, allow the user to select comments, etc.\n- On roadmap, add in quick links to changing lengths, details, etc.\n\nHere's the plugin we'd need:\n\nhttp:\/\/www.webdeveloperjuice.com\/2010\/02\/22\/create-simple-jquery-right-click-cross-browser-vertical-menu\/",
                       
"state": "active",
                       
"status": [

                       
],
                       
"added": "2014-04-21 15:19:28",
                       
"order": "4"
                   
},
                   
"specs": [

                   
]
               
},
               
"tags": [
                   
{
                       
"id": "290",
                       
"tag": "marketing",
                       
"added": "2013-11-13 15:36:36"
                   
},
                   
{
                       
"id": "6024",
                       
"tag": "design",
                       
"added": "2014-02-04 16:55:45"
                   
}
               
]
           
},
       
],
       
"created_at": "2013-02-03 02:53:51",
       
"updated_at": "2013-02-03 02:53:51"
   
},
   
{
       
"id": "141",
       
"title": "Future ",
       
"products": {
           
"id": "49"
       
},
       
"column_number": "3",
       
"roadmap_cards": [
           
{
               
"id": "455",
               
"title": "Social Connect",
               
"description": "Connect with various social networks, allowing people to search for listings within their networks, and invite others. ",
               
"public": "public",
               
"position": "0",
               
"pipeline": {
                   
"ideas": {
                       
"id": "7396",
                       
"title": "No title set",
                       
"description": "Add facebook connect to event page.",
                       
"state": "archived",
                       
"status": {
                           
"id": "982",
                           
"status": "Released"
                       
},
                       
"added": "2013-03-04 20:27:57",
                       
"order": "0"
                   
},
                   
"specs": {
                       
"id": "156332",
                       
"story": "As Rita the Retailer, I want to be able to import my ebay orders into CG, In order to make it easier to manage them in one place, dispatch along with Amazon orders, to save them time and effort",
                       
"acceptance_criteria": "User should be able to import a CSV or in the ebay orders page",
                       
"added": "2014-02-27 13:46:06",
                       
"order": "1"
                   
}
               
},
               
"tags": [
                   
{
                       
"id": "267",
                       
"tag": "data\/analytics",
                       
"added": "2013-10-08 18:32:12"
                   
},
                   
{
                       
"id": "265",
                       
"tag": "revenue",
                       
"added": "2013-10-08 18:32:20"
                   
},
                   
{
                       
"id": "292",
                       
"tag": "fun",
                       
"added": "2013-12-31 10:28:37"
                   
}
               
]
           
},
       
],
       
"created_at": "2013-02-03 02:53:51",
       
"updated_at": "2013-10-28 19:10:20"
   
}
]

Notes

  • All date and time is returned in UTC
  • “public” field indicates whether this roadmap card is publicly available in embedded roadmaps.
  • The text fields can include HTML markup
Have more questions? Submit a request

Comments

Powered by Zendesk