Retrieve Multiple Discussions
Returns an array of discussion objects present inside a particular story. This endpoint is paged and can be filtered by using page=1
, status
and per_page=1
for retrieving discussions per page.
https://mapi.storyblok.com/v1/spaces/:space_id/stories/:story_id/discussions
Path Parameters
-
:space_id
required numberNumeric ID of a space
-
:story_id
required numberID of the story
Query Parameters
-
per_page
numberDefault:
25
. Max:100
. Learn more under Pagination. -
page
numberDefault:
1
. Learn more under Pagination. -
by_status
stringFilters discussions based on their status. You can use values like
unsolved
, orsolved
to retrieve discussions with specific statuses.
Response Properties
-
discussions
The Discussions Object[]An array of discussions objects
-
id
numberThe numeric ID of the discussion
-
title
stringTitle of the discussion field
-
block_uid
stringThe ID of discussion block
-
fieldname
stringTechnical name of the discussion field
-
solved_at
stringThe time a discussion is resolved. (Format:
YYYY-mm-dd HH:MM
) -
component
stringThe component/block name to which the discussion belongs to
-
lang
stringLanguage code in which the discussion is present.
-
uuid
stringGenerated UUID string
-
last_comment
objectThe
last_comment
is an object that contains the details about the last comment of that discussion.-
id
numberThe numeric ID
-
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
) -
message
null or stringThe message of a comment, with the datatype of
null
or a string. -
message_json
objectAn array with properties of the message such as
type
,text
andattrs
. -
user_id
numberUser/numeric id of collaborator
-
uuid
stringGenerated UUID string
-
-
Request Example
curl "https://mapi.storyblok.com/v1/spaces/606/stories/1234/discussions?per_page=1&page=1&by_status=unsolved" \
-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/stories/1234/discussions', {
"per_page": "1",
"page": "1",
"by_status": "unsolved"
})
.then(response => {
console.log(response)
}).catch(error => {
console.log(error)
})
$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');
$client->get('/spaces/606/stories/1234/discussions', [
"per_page" => "1",
"page" => "1",
"by_status" => "unsolved"
])->getBody();
require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')
client.false('/spaces/606/stories/1234/discussions', {:params => {
"per_page" => "1",
"page" => "1",
"by_status" => "unsolved"
}})
HttpResponse<String> response = Unirest.get("https://mapi.storyblok.com/v1/spaces/606/stories/1234/discussions?per_page=1&page=1&by_status=unsolved")
.header("Authorization", "YOUR_OAUTH_TOKEN")
.asString();
var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/stories/1234/discussions?per_page=1&page=1&by_status=unsolved");
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/stories/1234/discussions?per_page=1&page=1&by_status=unsolved")! 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/stories/1234/discussions"
querystring = {"per_page":"1","page":"1","by_status":"unsolved"}
payload = ""
headers = {
'Content-Type': "application/json",
'Authorization': "YOUR_OAUTH_TOKEN"
}
response = requests.request("GET", url, data=payload, headers=headers, params=querystring)
print(response.text)