API Docs

Get Plug-in Apps

Gets Apps that have the specified plug-in added.

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

Contents

Permissions

  • Only Kintone Administrators can use this API.

Request Parameters

Parameter Type Required Description
id String Yes The ID of the plug-in.
offset Integer The number of plug-ins to skip from the list of plug-ins.
If ignored, this value is 0.
limit Integer The maximum number of plug-ins to retrieve.
Must be between 1 and 500.
The default number is 100.

Sample Request

JavaScript using kintone.api() 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

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

curl Sample

1
2
3
4
5
6

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

Response Parameters

Parameter Type Description
apps Array of Objects A list of objects containing the plug-in ID and name.
Objects are listed in ascending order of their App IDs.
apps[].id String The App ID.
apps[].name String The name of the App.

Sample Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{
    "apps": [
        {
            "id": "1",
            "name": "App 1"
        },
        {
            "id": "2",
            "name": "App 2"
        },
        {
            "id": "3",
            "name": "App 3"
        }
    ]
}