Get App Plugins

Gets the list of Plug-ins added to an App.

MethodGET
URLhttps://{subdomain}.kintone.com/k/v1/app/plugins.json
URL(guest space)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/plugins.json
Authentication Password Authentication, API Token Authentication, Session Authentication
Content-Typeapplication/json (not needed if specifying the query with a query string)

Contents

Pre-live settings

Apps may hold pre-live settings that have not yet been deployed to the live App. Access the pre-live settings with the below URL.

URL https://{subdomain}.kintone.com/k/v1/preview/app/plugins.json
URL(guest space) https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/plugins.json

Permissions

  • App Management Permissions are needed.

Request Parameters

Parameter Value Required Description
app Integer or String Yes The App ID.
lang String Optional The localized language to retrieve the data in:
  • default: retrieves the default names
  • en: retrieves the localized English names
  • zh: retrieves the localized Chinese names
  • ja: retrieves the localized Japanese names
  • es: retrieves the localized Spanish names
  • user: retrieves the localized names in the same language as the language setting set on the user used for the authentication.
If ignored, the default names will be retrieved.

Sample Request

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
var body = {
  'app': 1,
  'lang': 'en'
};
kintone.api(kintone.api.url('/k/v1/app/plugins.json', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

XMLHttpRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
var params = '?app=1&lang=en';
var url = 'https://{subdomain}.kintone.com/k/v1/app/plugins.json' + params;
console.log(url);
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send();

Response Parameters

Parameter Type Description
plugins Array of Objects A list of Plug-ins added to the App.
plugins[].id String The Plugin ID.
plugins[].name String The name of the Plugin.
plugins[].enabled Boolean The status of the plugin.
true for active plugins, and false for inactive plugins.
revision String The revision number of the App.

Sample Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "plugins": [
        {
            "id": "djmhffjhfgmebgnmcggopedaofckljlj",
            "name": "Plugin Name",
            "enabled": true
        }
    ],
    "revision": "2"
}