プラグインを追加しているアプリの一覧を取得する

プラグインを追加しているアプリ情報の一覧を取得します。

HTTPメソッド	GET
URL	https://sample.cybozu.com/k/v1/plugin/apps.json
認証	パスワード認証 , セッション認証 , OAuth認証
Content-Type	application/json

リクエストパラメーター

固定リンクがコピーされました

パラメーター名	型	必須	説明
id	文字列	必須	プラグインID
offset	数値または文字列	省略可	取得した一覧からスキップする数。省略すると、0が設定されます。
limit	数値または文字列	省略可	取得するアプリ数の上限。 1から500までの数値を指定できます。省略すると、100が設定されます。

レスポンスプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
apps	配列（オブジェクト）	プラグインが追加されているアプリ情報の配列並び順は、アプリIDの昇順です。追加しているアプリが存在しない場合は、空配列が返ります。
apps[].id	文字列	アプリID
apps[].name	文字列	アプリ名

必要なアクセス権

固定リンクがコピーされました

cybozu.com共通管理者

サンプル

固定リンクがコピーされました

サンプルリクエスト

リクエストURL（URLにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/plugin/apps.json?id=djmhffjhfgmebgnmcggopedaofckljlj&offset=1&limit=1

リクエストヘッダー（URLにパラメーターを含める場合）

1
2
3


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストURL（リクエストボディにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/plugin/apps.json

リクエストヘッダー（リクエストボディにパラメーターを含める場合）

1
2
3
4


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストボディ（リクエストボディにパラメーターを含める場合）

1
2
3
4
5


{
  "id": "djmhffjhfgmebgnmcggopedaofckljlj",
  "offset": 1,
  "limit": 1
}

サンプルレスポンス

1
2
3
4
5
6
7
8


{
  "apps": [
    {
      "id": "1",
      "name": "サンプルアプリ"
    }
  ]
}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

1
2
3
4
5
6


const body = {
  id: 'djmhffjhfgmebgnmcggopedaofckljlj',
  limit: 1,
};

await kintone.api(kintone.api.url('/k/v1/plugin/apps.json', true), 'GET', body);

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2
3
4
5
6
7


curl -X GET 'https://sample.cybozu.com/k/v1/plugin/apps.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "djmhffjhfgmebgnmcggopedaofckljlj",
    "limit": 1
  }'

補足

固定リンクがコピーされました

プラグインの追加を反映する前のアプリ情報も取得できます。

kintone API

kintone APIドキュメント

プラグインを追加しているアプリの一覧を取得する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

補足