Return a List of Ideas

You can use this API request to search for an idea.

/services/v2/idea.json

You can use the following parameters in your Return a list of ideas request:

Search options: q, type, lang
Projection options: include, exclude, includeOnly
Paging and sorting: page, pageSize, sort
Other options: wrap, v1

🚧

Permissions & Notes:

  • You must have the View list idea permission under Custom Roles in the Advanced Editor.

  • With the includeOnly parameter set to id and name (/services/v2/idea.json?includeOnly=id,name) to the AnswerHub REST API.

  • We added this request in version 1.6.3.5.

Sample Request

A GET search for an idea request to search for an idea sent to
https://apidocs.cloud.answerhub.com using a human-readable Username/Password (answerhub/test123) would look like this:

curl 
-u answerhub:test123 
-H "Accept: application/json" 
-H "Content-type: application/json" 
-X GET "https://apidocs.cloud.answerhub.com/services/v2/idea.json" -v

👍

Use of pageSize:

Note, we used the parameter pageSize=2 to decrease the length of the response. Without this parameter, the response would contain a page's worth of ideas. The number of ideas displayed per page is dependent on pageSize. To change pages, add the page=n parameter to the end of your request with n being the desired page number.

Sample Response

Successful Response:

  • HTTP Status 200 - OK
{
    "name": "",
    "sort": "active",
    "page": 1,
    "pageSize": 15,
    "pageCount": 1,
    "listCount": 4,
    "totalCount": 4,
    "sorts": [
        "active",
        "newest",
        "hottest",
        "votes",
        "viewCount",
        "usedCount",
        "answerCount",
        "answerCountAsc",
        "commentCount",
        "favoriteCount",
        "followers",
        "reportCount"
    ],
    "list": [
        {
            "id": "552",
            "type": "idea",
            "creationDate": 1547066702000,
            "creationDateFormatted": "01/09/2019 08:45 PM",
            "title": "Salesforce.com Plugin needs to sync company data!",
            "body": "<div class=\"fr-view clearfix\"><div class=\"fr-view clearfix\"><div class=\"fr-view clearfix\"><p>We need to check and make sure people are authenticated and paying us before they can come to this site and submit.</p></div></div></div>",
            "bodyAsHTML": "<div class=\"fr-view clearfix\">\n <div class=\"fr-view clearfix\">\n  <div class=\"fr-view clearfix\">\n   <p>We need to check and make sure people are authenticated and paying us before they can come to this site and submit.</p>\n  </div>\n </div>\n</div>",
            "author": {
                "id": 73,
                "username": "jessed",
                "realname": null,
                "avatar": "https://secure.gravatar.com/avatar/e5c51555d3f39d3cd0874b49684a258f?d=identicon&r=PG",
                "reputation": 0
            },
            "lastEditedAction": 619,
            "activeRevisionId": 552,
            "revisionIds": [
                552
            ],
            "lastActiveUserId": 108,
            "lastActiveDate": 1548425291000,
            "parentId": null,
            "parentAuthor": null,
            "originalParentId": null,
            "childrenIds": [
                822
            ],
            "commentIds": [],
            "marked": false,
            "topics": [
                "default"
            ],
            "primaryContainerId": 8,
            "containerIds": [
                7,
                8
            ],
            "plug": "salesforcecom-plugin-needs-to-sync-company-data",
            "wiki": false,
            "score": 20,
            "depth": 0,
            "reportCount": 0
        },
        {
            "id": "821",
            "type": "idea",
            "creationDate": 1548346751000,
            "creationDateFormatted": "01/24/2019 04:19 PM",
            "title": "Idea by REST API 101",
            "body": "<div class=\"fr-view clearfix\">Body of the idea</div>",
            "bodyAsHTML": "<div class=\"fr-view clearfix\">Body of the idea</div>",
            "author": {
                "id": 108,
                "username": "admin",
                "realname": null,
                "avatar": "https://secure.gravatar.com/avatar/4e955c70eeff0abe1974c9be300a8887?d=identicon&r=PG",
                "reputation": 61
            },
            "lastEditedAction": 997,
            "activeRevisionId": 832,
            "revisionIds": [
                832
            ],
            "lastActiveUserId": 108,
            "lastActiveDate": 1548346751000,
            "parentId": null,
            "parentAuthor": null,
            "originalParentId": null,
            "childrenIds": [],
            "commentIds": [],
            "marked": false,
            "topics": [
                "testidea"
            ],
            "primaryContainerId": 11,
            "containerIds": [
                7,
                11
            ],
            "plug": "idea-by-rest-api-101",
            "wiki": false,
            "score": 0,
            "depth": 0,
            "reportCount": 0
        },
        {
            "id": "550",
            "type": "idea",
            "creationDate": 1547066704000,
            "creationDateFormatted": "01/09/2019 08:45 PM",
            "title": "Google Finances",
            "body": "<div class=\"fr-view clearfix\"><div class=\"fr-view clearfix\"><div class=\"fr-view clearfix\"><p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Curabitur sed tortor. Integer aliquam adipiscing lacus. Ut nec urna et arcu imperdiet ullamcorper. Duis at lacus. Quisque purus sapien, gravida non, sollicitudin a, malesuada id, erat. Etiam vestibulum massa rutrum magna. Cras convallis convallis dolor. Quisque tincidunt pede ac urna. Ut tincidunt vehicula risus. Nulla eget metus eu erat semper rutrum. Fusce dolor quam, elementum at, egestas a, scelerisque sed, sapien. Nunc pulvinar arcu et pede. Nunc sed orci lobortis augue scelerisque mollis. Phasellus libero mauris, aliquam eu, accumsan sed, facilisis vitae, orci. Phasellus dapibus quam quis diam. Pellentesque habitant morbi tristique senectus et netus</p></div></div></div>",
            "bodyAsHTML": "<div class=\"fr-view clearfix\">\n <div class=\"fr-view clearfix\">\n  <div class=\"fr-view clearfix\">\n   <p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Curabitur sed tortor. Integer aliquam adipiscing lacus. Ut nec urna et arcu imperdiet ullamcorper. Duis at lacus. Quisque purus sapien, gravida non, sollicitudin a, malesuada id, erat. Etiam vestibulum massa rutrum magna. Cras convallis convallis dolor. Quisque tincidunt pede ac urna. Ut tincidunt vehicula risus. Nulla eget metus eu erat semper rutrum. Fusce dolor quam, elementum at, egestas a, scelerisque sed, sapien. Nunc pulvinar arcu et pede. Nunc sed orci lobortis augue scelerisque mollis. Phasellus libero mauris, aliquam eu, accumsan sed, facilisis vitae, orci. Phasellus dapibus quam quis diam. Pellentesque habitant morbi tristique senectus et netus</p>\n  </div>\n </div>\n</div>",
            "author": {
                "id": 85,
                "username": "Aurora134",
                "realname": null,
                "avatar": "https://secure.gravatar.com/avatar/97470c9f8fe662e7207e828ebd85eef6?d=identicon&r=PG",
                "reputation": 0
            },
            "lastEditedAction": 625,
            "activeRevisionId": 550,
            "revisionIds": [
                550
            ],
            "lastActiveUserId": 85,
            "lastActiveDate": 1547066704000,
            "parentId": null,
            "parentAuthor": null,
            "originalParentId": null,
            "childrenIds": [],
            "commentIds": [],
            "marked": false,
            "topics": [
                "finances"
            ],
            "primaryContainerId": 8,
            "containerIds": [
                7,
                8
            ],
            "plug": "google-finances",
            "wiki": false,
            "score": 0,
            "depth": 0,
            "reportCount": 0
        },
        {
            "id": "819",
            "type": "idea",
            "creationDate": 1441108800000,
            "creationDateFormatted": "09/01/2015 12:00 PM",
            "title": "title of an idea",
            "body": "<div class=\"fr-view clearfix\">body of an idea</div>",
            "bodyAsHTML": "<div class=\"fr-view clearfix\">body of an idea</div>",
            "author": {
                "id": 108,
                "username": "admin",
                "realname": null,
                "avatar": "https://secure.gravatar.com/avatar/4e955c70eeff0abe1974c9be300a8887?d=identicon&r=PG",
                "reputation": 61
            },
            "lastEditedAction": 979,
            "activeRevisionId": 823,
            "revisionIds": [
                823
            ],
            "lastActiveUserId": 108,
            "lastActiveDate": 1441108800000,
            "parentId": null,
            "parentAuthor": null,
            "originalParentId": null,
            "childrenIds": [],
            "commentIds": [],
            "marked": false,
            "topics": [
                "idea1",
                "idea2"
            ],
            "primaryContainerId": 11,
            "containerIds": [
                7,
                11
            ],
            "plug": "title-of-an-idea",
            "wiki": false,
            "score": 4,
            "depth": 0,
            "reportCount": 0
        }
    ]
}
{"name":"","sort":"active","page":1,"pageSize":15,"pageCount":1,"listCount":4,"totalCount":4,"sorts":["active","newest","hottest","votes","viewCount","usedCount","answerCount","answerCountAsc","commentCount","favoriteCount","followers","reportCount"],"list":[{"id":"552","type":"idea","creationDate":1547066702000,"creationDateFormatted":"01/09/2019 08:45 PM","title":"Salesforce.com Plugin needs to sync company data!","body":"<div class=\"fr-view clearfix\"><div class=\"fr-view clearfix\"><div class=\"fr-view clearfix\"><p>We need to check and make sure people are authenticated and paying us before they can come to this site and submit.</p></div></div></div>","bodyAsHTML":"<div class=\"fr-view clearfix\">\n <div class=\"fr-view clearfix\">\n  <div class=\"fr-view clearfix\">\n   <p>We need to check and make sure people are authenticated and paying us before they can come to this site and submit.</p>\n  </div>\n </div>\n</div>","author":{"id":73,"username":"jessed","realname":null,"emailHash":"defbe7aac736590cdc5a5fd73410485d505d227c8662ff61e8f3f7c1c0dd902d","avatar":"https://secure.gravatar.com/avatar/e5c51555d3f39d3cd0874b49684a258f?d=identicon&r=PG","reputation":0},"lastEditedAction":619,"activeRevisionId":552,"revisionIds":[552],"lastActiveUserId":108,"lastActiveDate":1548425291000,"parentId":null,"parentAuthor":null,"originalParentId":null,"childrenIds":[822],"commentIds":[],"marked":false,"topics":["default"],"primaryContainerId":8,"containerIds":[7,8],"plug":"salesforcecom-plugin-needs-to-sync-company-data","wiki":false,"score":20,"depth":0,"reportCount":0},{"id":"821","type":"idea","creationDate":1548346751000,"creationDateFormatted":"01/24/2019 04:19 PM","title":"Idea by REST API 101","body":"<div class=\"fr-view clearfix\">Body of the idea</div>","bodyAsHTML":"<div class=\"fr-view clearfix\">Body of the idea</div>","author":{"id":108,"username":"admin","realname":null,"emailHash":"1446851ccea76b1615800de8182d3433a381a446c2ea6ae45196e413c060c3cd","avatar":"https://secure.gravatar.com/avatar/4e955c70eeff0abe1974c9be300a8887?d=identicon&r=PG","reputation":61},"lastEditedAction":997,"activeRevisionId":832,"revisionIds":[832],"lastActiveUserId":108,"lastActiveDate":1548346751000,"parentId":null,"parentAuthor":null,"originalParentId":null,"childrenIds":[],"commentIds":[],"marked":false,"topics":["testidea"],"primaryContainerId":11,"containerIds":[7,11],"plug":"idea-by-rest-api-101","wiki":false,"score":0,"depth":0,"reportCount":0},{"id":"550","type":"idea","creationDate":1547066704000,"creationDateFormatted":"01/09/2019 08:45 PM","title":"Google Finances","body":"<div class=\"fr-view clearfix\"><div class=\"fr-view clearfix\"><div class=\"fr-view clearfix\"><p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Curabitur sed tortor. Integer aliquam adipiscing lacus. Ut nec urna et arcu imperdiet ullamcorper. Duis at lacus. Quisque purus sapien, gravida non, sollicitudin a, malesuada id, erat. Etiam vestibulum massa rutrum magna. Cras convallis convallis dolor. Quisque tincidunt pede ac urna. Ut tincidunt vehicula risus. Nulla eget metus eu erat semper rutrum. Fusce dolor quam, elementum at, egestas a, scelerisque sed, sapien. Nunc pulvinar arcu et pede. Nunc sed orci lobortis augue scelerisque mollis. Phasellus libero mauris, aliquam eu, accumsan sed, facilisis vitae, orci. Phasellus dapibus quam quis diam. Pellentesque habitant morbi tristique senectus et netus</p></div></div></div>","bodyAsHTML":"<div class=\"fr-view clearfix\">\n <div class=\"fr-view clearfix\">\n  <div class=\"fr-view clearfix\">\n   <p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Curabitur sed tortor. Integer aliquam adipiscing lacus. Ut nec urna et arcu imperdiet ullamcorper. Duis at lacus. Quisque purus sapien, gravida non, sollicitudin a, malesuada id, erat. Etiam vestibulum massa rutrum magna. Cras convallis convallis dolor. Quisque tincidunt pede ac urna. Ut tincidunt vehicula risus. Nulla eget metus eu erat semper rutrum. Fusce dolor quam, elementum at, egestas a, scelerisque sed, sapien. Nunc pulvinar arcu et pede. Nunc sed orci lobortis augue scelerisque mollis. Phasellus libero mauris, aliquam eu, accumsan sed, facilisis vitae, orci. Phasellus dapibus quam quis diam. Pellentesque habitant morbi tristique senectus et netus</p>\n  </div>\n </div>\n</div>","author":{"id":85,"username":"Aurora134","realname":null,"emailHash":"702fd8cad4918b739183cea758b66a846415c0bdfaeb61bfa817f09bb2df8edc","avatar":"https://secure.gravatar.com/avatar/97470c9f8fe662e7207e828ebd85eef6?d=identicon&r=PG","reputation":0},"lastEditedAction":625,"activeRevisionId":550,"revisionIds":[550],"lastActiveUserId":85,"lastActiveDate":1547066704000,"parentId":null,"parentAuthor":null,"originalParentId":null,"childrenIds":[],"commentIds":[],"marked":false,"topics":["finances"],"primaryContainerId":8,"containerIds":[7,8],"plug":"google-finances","wiki":false,"score":0,"depth":0,"reportCount":0},{"id":"819","type":"idea","creationDate":1441108800000,"creationDateFormatted":"09/01/2015 12:00 PM","title":"title of an idea","body":"<div class=\"fr-view clearfix\">body of an idea</div>","bodyAsHTML":"<div class=\"fr-view clearfix\">body of an idea</div>","author":{"id":108,"username":"admin","realname":null,"emailHash":"1446851ccea76b1615800de8182d3433a381a446c2ea6ae45196e413c060c3cd","avatar":"https://secure.gravatar.com/avatar/4e955c70eeff0abe1974c9be300a8887?d=identicon&r=PG","reputation":61},"lastEditedAction":979,"activeRevisionId":823,"revisionIds":[823],"lastActiveUserId":108,"lastActiveDate":1441108800000,"parentId":null,"parentAuthor":null,"originalParentId":null,"childrenIds":[],"commentIds":[],"marked":false,"topics":["idea1","idea2"],"primaryContainerId":11,"containerIds":[7,11],"plug":"title-of-an-idea","wiki":false,"score":4,"depth":0,"reportCount":0}]}
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!