GET api/v2.0/Ideation/IdeaDetails?ideationKey={ideationKey}
Gets the details of an idea.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ideationKey |
Unique identifier for the idea to be retrieved. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Detailed information about the idea specified.
IdeaDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| IdeationKey |
Unique identifier of the idea. |
globally unique identifier |
None. |
| Title |
Title of the idea. |
string |
None. |
| Description |
Description of the idea. |
string |
None. |
| LinkToViewIdea |
Direct link to view the idea on the main microsite. |
string |
None. |
| Status |
Object containing information about the status of the idea. |
IdeaStatus |
None. |
| Community |
The community the idea has been associated to. If null or doesn't exist (i.e. the idea is not associated to any community), the idea is considered to be a site-wide idea. |
Community |
None. |
| Categories |
All categories the idea has been associated to. |
Collection of IdeaCategory |
None. |
| TotalUpvotes |
Number of upvotes. |
integer |
None. |
| TotalDownvotes |
Number of downvotes. |
integer |
None. |
| HasOfficialComment |
True if this idea has an official comment from an admin. |
boolean |
None. |
| Author |
Information about the author of the idea. |
ContactConcise |
None. |
| IsAnonymous |
True if the idea was submitted anonymously. |
boolean |
None. |
| CreatedOn |
DateTime the idea was created. |
date |
None. |
| UpdatedOn |
Most recent DateTime the idea was updated. |
date |
None. |
| AttachmentURLs |
Temporary URLs to view or download any attachments associated with the idea. |
Collection of IdeaAttachment |
None. |
Response Formats
application/json, text/json
{
"IdeationKey": "2fae5482-d3d5-49d4-b071-35fd7ccec3ac",
"Title": "sample string 2",
"Description": "sample string 3",
"LinkToViewIdea": "sample string 4",
"Status": null,
"Community": null,
"Categories": null,
"TotalUpvotes": 5,
"TotalDownvotes": 6,
"HasOfficialComment": true,
"Author": {
"LinkToProfile": "sample string 1",
"PictureUrl": "sample string 2",
"ContactKey": "a69b35db-a780-42d8-9fcf-17b91b0ed358",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"DisplayName": "sample string 6",
"EmailAddress": "sample string 7",
"ContactStatusCode": "sample string 8",
"PrefixCode": "sample string 9",
"UpdatedOn": "2025-10-27T18:32:14.9106085Z",
"UpdatedByContactKey": "b7404721-7962-496a-b65f-f95e53c45a42",
"CompanyName": "sample string 12",
"CompanyTitle": "sample string 13",
"SuffixCode": "sample string 14",
"Designation": "sample string 15",
"LegacyContactKey": "sample string 16",
"InformalName": "sample string 17",
"MiddleName": "sample string 18",
"IsCompany": true,
"CompanyLegacyContactKey": "sample string 20",
"AMSDirectoryOptOut": true,
"HLDirectoryOptOut": true,
"HLContactMeOptOut": true,
"LargePictureUrl": "sample string 24",
"AgreedToTermsDateTime": "2025-10-27T18:32:14.9106085Z"
},
"IsAnonymous": true,
"CreatedOn": "2025-10-27T18:32:14.9106085Z",
"UpdatedOn": "2025-10-27T18:32:14.9106085Z",
"AttachmentURLs": null
}
application/xml
Sample not available.
text/xml
Sample not available.