kintone API ドキュメント

複数のアプリの情報を取得する

目次

複数のアプリの情報を取得する

指定した条件に当てはまるアプリの情報を取得します。
一度に取得できるアプリ数は、100 件までです。

URL

通常のアプリ
https://sample.cybozu.com/k/v1/apps.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/apps.json

HTTP メソッド

GET

必要なアクセス権

次のいずれかの権限が必要です。

  • アプリのレコード閲覧権限
  • アプリのレコード追加権限

リクエスト

パラメーター
パラメーター名 型 必須 説明
ids 配列（数値または文字列） 省略可 アプリ ID
1 から 9,223,372,036,854,775,807 までの整数を指定できます。
最大で 100 件のアプリ ID を指定できます。
「null」 または空配列を指定すると、値を省略したとみなされます。
codes 配列（文字列） 省略可 アプリコード
1 文字以上 64 文字以下で指定します。
完全一致で、大文字と小文字は区別されます。
最大で 100 件のアプリコードを指定できます。
「null」 または空配列を指定すると、値を省略したとみなされます。
name 文字列 省略可 アプリ名またはその一部
64 文字以内で指定します。
部分一致で、大文字と小文字は区別されません。
複数の言語でアプリ名を設定している場合は、標準のアプリ名と API を実行するユーザーの表示言語のアプリ名が検索対象です。
「null」 または空配列を指定すると、値を省略したとみなされます。
spaceIds 配列（数値または文字列） 省略可 スペース ID
1 から 9,223,372,036,854,775,807 までの整数を指定できます。
最大で 100 のスペース ID を指定できます。
「null」 または空配列を指定すると、値を省略したとみなされます。
offset 数値または文字列 省略可 取得するアプリの先頭からスキップする数
省略すると 0 が設定されます。
limit 数値または文字列 省略可 取得する件数
1 から 100 までの整数を指定できます。
省略すると 100 が設定されます。
リクエストの例（URL にパラメーターを含める場合）
URL

https://sample.cybozu.com/k/v1/apps.json?name=TEST&codes[0]=FOO&codes[1]=BAR

ヘッダー
1
2
3

{
  "X-Cybozu-API-Token": "API_TOKEN"
}

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

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

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

ヘッダー
1
2
3
4

{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

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

ボディ
1
2
3
4

{
  "codes": ["FOO", "BAR"],
  "name": "TEST"
}

レスポンス

プロパティ
プロパティ名 型 説明
apps 配列 アプリの情報の一覧
apps[].appId 文字列 アプリ ID
apps[].code 文字列 アプリコード
未設定の場合は空文字列が返ります。
apps[].name 文字列 アプリ名
言語ごとにアプリ名を設定している場合、API の実行ユーザーが設定している言語に応じたアプリ名が返ります。
apps[].description 文字列 アプリの説明
未設定の場合は空文字列が返ります。
言語ごとに説明を設定している場合は、API の実行ユーザーが設定している言語に応じた説明が返ります。
apps[].spaceId 文字列 スペース ID
スペースに所属していないアプリでは、「null」が返ります。
apps[].threadId 文字列 スレッド ID
スペースに所属していないアプリでは、「null」が返ります。
apps[].createdAt 文字列 作成日時
apps[].creator オブジェクト 作成者情報
apps[].creator.code 文字列 作成者のコード
停止／削除／非利用ユーザーの場合は、空文字列が返ります。
apps[].creator.name 文字列 作成者の名前
停止／削除／非利用ユーザーの場合は、空文字列が返ります。
apps[].modifiedAt 文字列 更新日時
apps[].modifier オブジェクト 更新者情報
apps[].modifier.code 文字列 更新者のコード
停止／削除／非利用ユーザーの場合は、空文字列が返ります。
apps[].modifier.name 文字列 更新者の名前
停止／削除／非利用ユーザーの場合は、空文字列が返ります。
レスポンスの例
 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

{
  "apps": [
    {
      "appId": "1",
      "code": "FOO",
      "name": "案件管理",
      "description": "案件ごとに、受注の確度や金額はもちろん、活動の履歴も記録できるアプリです。",
      "spaceId": "2",
      "threadId": "3",
      "createdAt": "2021-10-01T05:14:05.000Z",
      "creator": {
        "code": "tanaka",
        "name": "田中太郎"
      },
      "modifiedAt": "2021-10-02T05:22:05.000Z",
      "modifier": {
        "code": "tanaka",
        "name": "田中太郎"
      }
    },
    {
      "appId": "2",
      "code": "BAR",
      "name": "TEST",
      "description": "",
      "spaceId": null,
      "threadId": null,
      "createdAt": "2021-10-10T13:25:05.000Z",
      "creator": {
        "code": "tanaka",
        "name": "田中太郎"
      },
      "modifiedAt": "2021-10-10T13:25:05.000Z",
      "modifier": {
        "code": "tanaka",
        "name": "田中太郎"
      }
    }
  ]
}

サンプルコード

curl を使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10

curl -X GET 'https://sample.cybozu.com/k/v1/apps.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "codes": [
      "FOO",
      "BAR"
    ],
    "name": "TEST"
  }'
kintone REST API リクエストを送信する API を使ったリクエスト
1
2
3
4
5
6
7
8
9

const body = {
  codes: [
    'FOO',
    'BAR'
  ],
  name: 'TEST'
};

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