Retrieve one Idea
Returns a single idea object by providing a specific numeric id.
https://mapi.storyblok.com/v1/spaces/:space_id/ideas/:idea_id
Path Parameters
-
:space_id
required numberNumeric ID of a space
-
:idea_uuid
required stringNumeric uuid of an idea
Response Properties
-
idea
The Ideation Room ObjectA single idea object
-
id
numberNumeric ID of the Idea
-
name
stringName of the Idea
-
description
stringA description of your Idea
-
content
objectThe content of your Idea
-
created_at
stringCreation date (Format:
yyyy-MM-dd'T'HH:mm:ssZ
) -
updated_at
stringLatest update date (Format:
yyyy-MM-dd'T'HH:mm:ssZ
) -
deleted_at
stringDeleted date (Format: YYYY-mm-dd HH:MM)
-
status
stringStatus of approval
-
story_ids
number[]List of story ids
-
is_private
booleanDefines the public or private status of the idea
-
bookmarks
objectThe external resources URLs and their names with _uid
-
_uid
stringUUID
-
link
stringThe string value of the URL from Idea's external resources.
-
label
stringThe string value of the name of the external resource URL in the Idea.
-
-
internal_tags_list
object[]List of objects containing the details of tags used for the component
-
id
numberId of the tag
-
name
stringName of the tag
-
-
internal_tag_ids
string[]List of ids of the tags assigned to the component
-
author
objectThe author object inside an Idea
-
id
numberThe numeric ID
-
avatar
stringAvatar of collaborator usually an image
-
userid
stringUser ID of collaborator
-
friendly_name
stringFriendly name of collaborator
-
-
assignee
objectThe assignee object inside an Idea
-
id
numberThe numeric ID
-
avatar
stringAvatar of collaborator usually an image
-
userid
stringUser ID of collaborator
-
friendly_name
stringFriendly name of collaborator
-
-
stories
Idea's Stories ObjectAn array of the idea's stories object
-
name
stringThe complete name provided for the story
-
id
numberThe numeric ID
-
full_slug
stringThe full slug of the story, combining the parent folder(s) and the designated story slug
-
-
Example Request
curl "https://mapi.storyblok.com/v1/spaces/606/ideas/1a2b3456-c7d8-9ef1-gh01-11i2jk13l14m" \
-X GET \
-H "Authorization: YOUR_OAUTH_TOKEN" \
-H "Content-Type: application/json"
// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.get('/spaces/606/ideas/1a2b3456-c7d8-9ef1-gh01-11i2jk13l14m', {})
.then(response => {
console.log(response)
}).catch(error => {
console.log(error)
})
$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');
$client->get('/spaces/606/ideas/1a2b3456-c7d8-9ef1-gh01-11i2jk13l14m')->getBody();
require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')
client.false('/spaces/606/ideas/1a2b3456-c7d8-9ef1-gh01-11i2jk13l14m')
HttpResponse<String> response = Unirest.get("https://mapi.storyblok.com/v1/spaces/606/ideas/1a2b3456-c7d8-9ef1-gh01-11i2jk13l14m")
.header("Authorization", "YOUR_OAUTH_TOKEN")
.asString();
var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/ideas/1a2b3456-c7d8-9ef1-gh01-11i2jk13l14m");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
IRestResponse response = client.Execute(request);
import Foundation
let headers = [
"Content-Type": "application/json",
"Authorization": "YOUR_OAUTH_TOKEN"
]
let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/606/ideas/1a2b3456-c7d8-9ef1-gh01-11i2jk13l14m")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)
request.method = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
import requests
url = "https://mapi.storyblok.com/v1/spaces/606/ideas/1a2b3456-c7d8-9ef1-gh01-11i2jk13l14m"
querystring = {}
payload = ""
headers = {
'Content-Type': "application/json",
'Authorization': "YOUR_OAUTH_TOKEN"
}
response = requests.request("GET", url, data=payload, headers=headers, params=querystring)
print(response.text)
You will receive an idea object as a response.