Retrieve Multiple Ideas

Returns an array of idea objects.

https://mapi.storyblok.com/v1/spaces/:space_id/ideas/

Path Parameters

:space_id
required number

Numeric ID of a space

Query Parameters

sort_by
string

Possible values: created_at:asc, created_at:desc, updated_at:asc, updated_at:desc, short_filename:asc, short_filename:desc
per_page
number

Default: 25. Max: 100. Learn more under Pagination.
filter_by_name
string or object

Filter by a specific name of your idea.
by_status
string

Filter ideas based on their status.
with_tag
string

Filter by specific tag(s). Multiple tags can be provided as a comma-separated string (treated like an OR operator). Examples:
with_tag=featured
with_tag=featured,editors_choice
in_trash
boolean

Filter by items in the trash folder
favourite
boolean

Filter by your favourites.
by_assignee_id
number

Filter by the assignee's id
discussions
Idea's Discussions Object[]

An array of the idea's discussions objects
- undefined
  
  Numeric ID of the specific idea's discussion
- undefined
- undefined
- undefined
- undefined
- undefined
- undefined
- undefined
- undefined
- undefined
comments
Idea's Comments Object[]

An array of idea's comment objects
- undefined
- undefined
- undefined
- undefined
- undefined
- undefined
- undefined
- undefined
by_ids
string

Filter by ids (comma separated)

Response Properties

idea
The Ideation Room Object

A single idea object
- id
  number
  
  Numeric ID of the Idea
- name
  string
  
  Name of the Idea
- description
  string
  
  A description of your Idea
- content
  object
  
  The content of your Idea
- created_at
  string
  
  Creation date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
- updated_at
  string
  
  Latest update date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
- deleted_at
  string
  
  Deleted date (Format: YYYY-mm-dd HH:MM)
- status
  string
  
  Status of approval
- story_ids
  number[]
  
  List of story ids
- is_private
  boolean
  
  Defines the public or private status of the idea
- bookmarks
  object
  
  The external resources URLs and their names with _uid
  - _uid
    string
    
    UUID
  - link
    string
    
    The string value of the URL from Idea's external resources.
  - label
    string
    
    The 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
    number
    
    Id of the tag
  - name
    string
    
    Name of the tag
- internal_tag_ids
  string[]
  
  List of ids of the tags assigned to the component
- author
  object
  
  The author object inside an Idea
  - id
    number
    
    The numeric ID
  - avatar
    string
    
    Avatar of collaborator usually an image
  - userid
    string
    
    User ID of collaborator
  - friendly_name
    string
    
    Friendly name of collaborator
- assignee
  object
  
  The assignee object inside an Idea
  - id
    number
    
    The numeric ID
  - avatar
    string
    
    Avatar of collaborator usually an image
  - userid
    string
    
    User ID of collaborator
  - friendly_name
    string
    
    Friendly name of collaborator
- stories
  Idea's Stories Object
  
  An array of the idea's stories object
  - name
    string
    
    The complete name provided for the story
  - id
    number
    
    The numeric ID
  - full_slug
    string
    
    The full slug of the story, combining the parent folder(s) and the designated story slug

Select a Language

Example Request

Request

curl "https://mapi.storyblok.com/v1/spaces/606/ideas/" \
  -X GET \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json"

Request

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.get('/spaces/606/ideas/', {})
  .then(response => {
    console.log(response)
  }).catch(error => { 
    console.log(error)
  })

Request

$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');

$client->get('/spaces/606/ideas/')->getBody();

Request

require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')

client.false('/spaces/606/ideas/')

Request

HttpResponse<String> response = Unirest.get("https://mapi.storyblok.com/v1/spaces/606/ideas/")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .asString();

Request

var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/ideas/");
var request = new RestRequest(Method.GET);

request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
IRestResponse response = client.Execute(request);

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/")! 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()

Request

import requests

url = "https://mapi.storyblok.com/v1/spaces/606/ideas/"

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)

Query Examples

spaces/:space_id/ideas?sort_by=created_at:asc

spaces/:space_id/ideas?per_page=10

spaces/:space_id/ideas?by_status=in_review

spaces/:space_id/ideas?by_assignee_id=12345

Prev Retrieve one Idea

Next Retrieve Discussions in Idea