API Docs

Get Installed Plug-ins

Gets the list of plug-ins imported into Kintone.

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

Contents

Permissions

  • No permissions are needed.

Request Parameters

Parameter Value Required Description
offset Integer The number of plug-ins to skip from the list of installed plug-ins.
If ignored, this value is 0.
limit Integer The maximum number of plug-ins to retrieve.
Must be between 1 and 100.
The default number is 100.
ids Array of strings The plug-in ids. The maximum limit of ids that can be specified is 100.
If null or an empty array is specified, this parameter will be ignored, and a list of plug-ins will be returned.

Sample Request

JavaScript using kintone.api()

Sample when the ids parameter is ignored

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

var body = {
  'offset': 1,
  'limit': 3
};
kintone.api(kintone.api.url('/k/v1/plugins.json', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

Sample when the ids parameter is specified

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

var body = {
  'ids': ['nldmflmpgchoodanjholbdewsdjkhpban', 'jdkslfbeksonbmvkelsodkfyquxnsja']
};
kintone.api(kintone.api.url('/k/v1/plugins.json', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

curl Sample

Sample when the ids parameter is ignored

1
2
3
4
5
6

curl -X GET 'https://{subdomain}.kintone.com/k/v1/plugins.json' \
  -H 'X-Cybozu-Authorization:{AuthorizationCode}' \
  -H 'Content-Type: application/json' \
  -d '{
    "offset": 1, "limit": 3
  }'

Sample when the ids parameter is specified

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

curl -X GET 'https://{subdomain}.kintone.com/k/v1/plugins.json' \
  -H 'X-Cybozu-Authorization:{AuthorizationCode}' \
  -H 'Content-Type: application/json' \
  -d '{
    "ids": ["nldmflmpgchoodanjholbdewsdjkhpban", "jdkslfbeksonbmvkelsodkfyquxnsja"]
  }'

### Response Parameters {#response-parameters}

| Parameter | Type | Description |
| :-- | :-- | :-- |
| plugins | Array of Objects | A list of plug-ins added to the App.<br>Plug-ins are listed in descending order of the datetime they are added.|
| plugins[].id | String | The plug-in ID. |
| plugins[].name | String | The name of the plug-in. |
| plugins[].isMarketPlugin | Boolean | States whether or not the plug-in is a Marketplace plug-in.<ul><li>`true`: The plug-in is a Marketplace plug-in.</li><li>`false`: The plug-in is not a Marketplace plug-in.</li></ul> |
| plugins[].version | String | The version number of the plug-in. |
| plugins[].description | String | The Plug-in description. If there is no description, an empty string will be returned. |

### Sample Response {#sample-response}

```json
{
    "plugins": [
        {
          "id": "djmhffjhfgmebgnmcggopedaofckljlj",
          "name": "Plugin 1",
          "isMarketPlugin": false,
          "version": "1",
          "description": "Description of Plugin 1"
        },
        {
          "id":"ejgcopfamifdhmkafjgidfmgjdmiaplf",
          "name":"Plugin 2",
          "isMarketPlugin":false,
          "version":"2",
          "description": "Description of Plugin 2"
        },
        {
          "id":"fdeplpmkengkldpdlaiegpokgmaabkkb",
          "name":"Plugin 3",
          "isMarketPlugin":false,
          "version":"4.5.1",
          "description": "Description of Plugin 3"
          }
    ]
}