Retrieve Settings
Retrieve settings inside Space Plugins and Tool Plugins. To do so, obtain an OAuth token or a Personal Access Token.
/spaces/:space_id/app_provisions/:app_id
To generate a personal access token, you can do that from My Account → Account Settings → Personal access token.
You can do similar for Field Plugin by using the Datasources. Follow for more details from our Datasources documentation.
Path Parameters
-
:space_id
required numberNumeric id of a space
-
:app_id
numberNumeric id of an app
Response Properties
-
app
The Plugin ObjectThe app object
-
id
numberSpace Plugin or Tool Plugin id
-
name
stringSpace Plugin or Tool Plugin name
-
slug
stringThe slug specific to this Space Plugin or Tool Plugin
-
icon
stringIcon image path of the Space Plugin or Tool Plugin from the Extension Details
-
plan_level
numberPlan Level of Space
-
preview_video
stringDefine the video URL in the Space Plugin or Tool Plugin configured on the Extension Details in the settings
-
app_url
stringSpace Plugin or Tool Plugin URL
-
description
stringA description of your Space Plugin or Too Plugin
-
intro
stringA short description of your Space Plugin or Tool Plugin
-
screenshot
stringA screenshot image path of your Space Plugin or Tool Plugin
-
status
stringStatus of whether the Space Plugin or Tool Plugin is created or not
-
website
stringWebsite URL of your Space Plugin or Tool Plugin
-
author
stringAuthor of the Space Plugin or Tool Plugin
-
updated_at
stringLatest update date (Format:
yyyy-MM-dd'T'HH:mm:ssZ
) -
field_type_ids
number[]An array of field type ids
-
embedded_app_url
stringAn embedded Space Plugin or Tool Plugin URL
-
dev_embedded_app_url
stringA developer mode of embedded Space Plugin or Tool Plugin URL
-
dev_oauth_redirect_uri
stringA developer mode of OAuth Space Plugin or Tool Plugin URI
-
in_sidebar
booleanA status in the sidebar if your plugin is Space Plugin
-
in_toolbar
booleanA status in the toolbar if your plugin is Tool Plugin
-
sidebar_icon
stringYour Space Plugin sidebar icon image path
-
enable_space_settings
booleanA status to show whether your Space Plugin or Tool Plugin is enabled for space level or not
-
-
app_provision
The App Provision Object-
public_config
stringPublic configurations
-
session
stringStatus of the session
-
slug
stringThe slug specific to this Space Plugin or Tool Plugin
-
app_id
numberSpace Plugin or Tool Plugin id
-
name
stringSpace Plugin or Tool Plugin name
-
in_sidebar
booleanA status in the sidebar if your plugin is Space Plugin
-
in_toolbar
booleanA status in the toolbar if your plugin is Tool Plugin
-
sidebar_icon
stringYour Space Plugin sidebar icon image path
-
enable_space_settings
booleanA status to show whether your Space Plugin or Tool Plugin is enabled for space level or not
-
space_level_settings
objectSpace level settings
-
curl "https://mapi.storyblok.com/v1/spaces/606/app_provisions/a8d372f8-5659-4f77-b549-0a82ff9c6e72" \
-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/app_provisions/a8d372f8-5659-4f77-b549-0a82ff9c6e72', {})
.then(response => {
console.log(response)
}).catch(error => {
console.log(error)
})
$client = new \Storyblok\Client('YOUR_OAUTH_TOKEN');
$client->get('/spaces/606/app_provisions/a8d372f8-5659-4f77-b549-0a82ff9c6e72')->getBody();
require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')
client.false('/spaces/606/app_provisions/a8d372f8-5659-4f77-b549-0a82ff9c6e72')
HttpResponse<String> response = Unirest.get("https://mapi.storyblok.com/v1/spaces/606/app_provisions/a8d372f8-5659-4f77-b549-0a82ff9c6e72")
.header("Authorization", "YOUR_OAUTH_TOKEN")
.asString();
var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/app_provisions/a8d372f8-5659-4f77-b549-0a82ff9c6e72");
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/app_provisions/a8d372f8-5659-4f77-b549-0a82ff9c6e72")! 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/app_provisions/a8d372f8-5659-4f77-b549-0a82ff9c6e72"
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)