Retrieve Settings of an Installed Extension

Retrieve settings of an extension by the numeric ID. To do so, obtain an OAuth token or a Personal Access Token.

This endpoints gives both the app and app_provision objects in the response for the specific extension.

https://mapi.storyblok.com/v1/spaces/:space_id/app_provisions/:extension_id

You can find more information on how to get your OAuth token on our OAuth 2.0 Authorization Flow documentation.

To generate a personal access token, you can do that from My Account → Account Settings → Personal access token.

Path Parameters

:space_id
required number

Numeric ID of a space
:extension_id
required number

Numeric id of an extension

Response Properties

app
The Extension Object

The extension object
- id
  number
  
  Numeric ID of the Extension
- name
  string
  
  Name of the Extension
- slug
  string
  
  The slug specific to this Extension
- icon
  string
  
  Icon image path of the Extension from the Extension Details
- plan_level
  number
  
  Plan Level of Space
- preview_video
  string
  
  Define the video URL in the extension configured on the Extension Details in the settings
- app_url
  string
  
  Extension URL
- description
  string
  
  A description of your extension
- intro
  string
  
  A short description of your extension
- screenshot
  string
  
  A screenshot image path of your extension
- status
  string
  
  Status of the extension
- website
  string
  
  Website URL of your extension
- author
  string
  
  Author of the extension
- updated_at
  string
  
  Latest update date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
- field_type_ids
  number[]
  
  An array of field type ids
- embedded_app_url
  string
  
  An embedded Space app or Tool Plugin URL
- dev_embedded_app_url
  string
  
  A developer mode of embedded Space Plugin or Tool Plugin URL
- dev_oauth_redirect_uri
  string
  
  A developer mode of OAuth Space Plugin or Tool Plugin URI
- in_sidebar
  boolean
  
  A status in the sidebar if your plugin is a space app
- in_toolbar
  boolean
  
  A status in the toolbar if your plugin is tool plugin
- sidebar_icon
  string
  
  Your space app sidebar icon image path
- oauth_redirect_uri
  string
  
  OAuth Space Plugin or Tool Plugin URI
- enable_space_settings
  boolean
  
  A status to show whether your extension is enabled for space level settings or not
app_provision
The App Provision Object

The app_provision object
- public_config
  string
  
  Public configurations
- session
  string
  
  Status of the session
- slug
  string
  
  The slug specific to this Space Plugin or Tool Plugin
- extension_id
  number
  
  Space Plugin or Tool Plugin id
- name
  string
  
  Space Plugin or Tool Plugin name
- in_sidebar
  boolean
  
  A status in the sidebar if your plugin is a space app
- in_toolbar
  boolean
  
  A status in the toolbar if your plugin is tool plugin
- sidebar_icon
  string
  
  Your space app sidebar icon image path
- enable_space_settings
  boolean
  
  A status to show whether your extension is enabled for space level settings or not
- space_level_settings
  object
  
  Space level settings

Select a Language

Request

curl "https://mapi.storyblok.com/v1/spaces/606/app_provisions/123123" \
  -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/app_provisions/123123', {})
  .then(response => {
    console.log(response)
  }).catch(error => { 
    console.log(error)
  })

Request

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

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

Request

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

client.false('/spaces/606/app_provisions/123123')

Request

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

Request

var client = new RestClient("https://mapi.storyblok.com/v1/spaces/606/app_provisions/123123");
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/app_provisions/123123")! 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/app_provisions/123123"

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)

Prev The App Provision Object

Next Retrieve Settings of all Installed Extensions