kintone APIドキュメント

1件のアプリの情報を取得する

目次

1件のアプリの情報を取得する

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

1件のアプリの情報を取得します。

URL

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

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

HTTPメソッド

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

GET

必要なアクセス権

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

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

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

リクエスト

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

パラメーター

リクエストパラメーターは、URLまたはリクエストボディで指定できます。

パラメーター名 型 必須 説明
id 数値または文字列 必須 アプリID
リクエストの例（URLにパラメーターを含める場合）
URL

https://sample.cybozu.com/k/v1/app.json?id=1

ヘッダー
1
2
3

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

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

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

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

ヘッダー
1
2
3
4

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

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

ボディ
1
2
3

{
  "id": "1"
}

レスポンス

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

プロパティ
プロパティ名 型 説明
appId 文字列 アプリID
code 文字列 アプリコード
未設定の場合は空文字列が返ります。
name 文字列 アプリ名
言語ごとにアプリ名を設定している場合、APIの実行ユーザーが設定している言語に応じたアプリ名が返ります。
description 文字列 アプリの説明
未設定の場合は空文字列が返ります。
言語ごとに説明を設定している場合は、APIの実行ユーザーが設定している言語に応じた説明が返ります。
spaceId 文字列 スペースID
スペースに所属していないアプリでは、「null」が返ります。
threadId 文字列 スレッドID
スペースに所属していないアプリでは、「null」が返ります。
createdAt 文字列 作成日時
creator オブジェクト 作成者情報
creator.code 文字列 作成者のコード
停止／削除／非利用ユーザーの場合は、空文字列が返ります。
creator.name 文字列 作成者の名前
停止／削除／非利用ユーザーの場合は、空文字列が返ります。
modifiedAt 文字列 更新日時
modifier オブジェクト 更新者情報
modifier.code 文字列 更新者のコード
停止／削除／非利用ユーザーの場合は、空文字列が返ります。
modifier.name 文字列 更新者の名前
停止／削除／非利用ユーザーの場合は、空文字列が返ります。
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

{
  "appId": "1",
  "code": "",
  "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": "田中太郎"
  }
}

サンプルコード

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

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

curl -X GET 'https://sample.cybozu.com/k/v1/app.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 1
  }'
kintone.api()を使ったリクエスト

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

1
2
3
4
5

const body = {
  id: kintone.app.getId()
};

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