kintone API ドキュメント

スペース情報を取得する

目次

caution
警告

このページで説明しているAPIは、開発を検討中のAPIです。

アップデートオプション内の「開発中の新機能」から動作をお試しいただけます。 設定方法は、 新機能の有効／無効の切り替え手順 (External link) を参照してください。

APIに関するフィードバックを、ユースケースとともに、 kintone の改善に協力する (External link) フォームへぜひご登録ください。

フィードバックの例
  • APIラボで提供されているAPIを早く本番環境で利用したい
  • こういう用途で使うために、このようなAPIを提供してほしい

スペース情報を取得する

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

現在開いているスペースの情報を取得します。

利用するには開発中の新機能の「スペースの情報を取得できるJavaScript API」を有効にしてください。

このAPIは非同期なAPIです。同期的に処理したい場合は、次のページを参照してください。

関数

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

PC

kintone.space.get()

モバイル

なし

引数

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

なし

戻り値

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

戻り値はPromiseオブジェクトです。 Promiseオブジェクトの解決時に次の値が取得できます。

プロパティ名 型 説明
id 文字列 スペースID
name 文字列 スペース名
isGuest 真偽値 ゲストスペースかどうか
  • true：ゲストスペース
  • false：通常のスペース
null になる条件
  • 利用できない画面
  • スペース外アプリの画面で実行した場合

利用できる画面

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

PC
  • レコード一覧画面
  • レコード追加画面
  • レコード編集画面
  • レコード詳細画面
  • グラフの画面
  • アプリ設定のプラグイン個別設定画面
  • スペーストップ画面
  • スレッド画面
モバイル

なし

information

モバイルでの対応は検討中です。

サンプルコード

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

1
2
3
4
5
6

await kintone.space.get();
// {
//    id: '1',
//    name: 'スペース名',
//    isGuest: false
// }