kintone API

kintone APIドキュメントトップへ
kintone APIドキュメントのアイコン

kintone APIドキュメント

kintone APIのアップデートおよび提供に関する方針
フィールド形式
クエリの書き方
kintone Webhook
kintoneコーディングガイドライン
kintoneセキュアコーディングガイドライン
kintone REST APIの共通仕様
認証
アプリのグラフの設定を取得する
アプリのグラフ設定を変更する
フィールドを取得する
フィールドを追加する
フィールドの設定を変更する
フィールドを削除する
フォームのレイアウトを取得する
フォームのレイアウトを変更する
フォームの設計情報を取得する
一覧の設定を取得する
一覧の設定を変更する
アプリの一般設定を取得する
アプリの一般設定を変更する
プロセス管理の設定を取得する
プロセス管理の設定を変更する
アプリに追加されているプラグインの一覧を取得する
アプリにプラグインを追加する
JavaScript / CSSカスタマイズ設定を取得する
JavaScript / CSSカスタマイズ設定を変更する
アプリの条件通知の設定を取得する
アプリの条件通知の設定を変更する
レコードの条件通知の設定を取得する
レコードの条件通知の設定を変更する
リマインダーの条件通知の設定を取得する
リマインダーの条件通知の設定を変更する
アプリのアクセス権の設定を取得する
アプリのアクセス権の設定を変更する
レコードのアクセス権の設定を取得する
レコードのアクセス権の設定を変更する
フィールドのアクセス権の設定を取得する
フィールドのアクセス権の設定を変更する
アプリのアクション設定を取得する
アプリのアクション設定を変更する
アプリの所属するスペースを変更する
アプリの設定を運用環境へ反映する
アプリの設定の運用環境への反映状況を確認する
1件のアプリの情報を取得する
複数のアプリの情報を取得する
動作テスト環境にアプリを作成する
アプリ管理者用メモを取得する
アプリ管理者用メモを変更する
アプリの使用状況を取得する
1件のレコードを取得する
1件のレコードを登録する
1件のレコードを更新する
複数のレコードを取得する
複数のレコードを登録する
複数のレコードを更新する
複数のレコードを削除する
（レコードの一括取得）カーソルを作成する
（レコードの一括取得）カーソルからレコードを取得する
（レコードの一括取得）カーソルを削除する
レコードコメントを取得する
レコードコメントを投稿する
レコードコメントを削除する
レコードの作業者を更新する
1件のレコードのステータスを更新する
複数のレコードのステータスを更新する
複数アプリのレコード操作を一括処理する
APIを実行したユーザーのレコードのアクセス権の設定を取得する
スペースの情報を取得する
スペースの設定を変更する
テンプレートからスペースを作成する
スペースを削除する
スペースの本文を更新する
スペースのメンバーとスペース管理者の情報を取得する
スペースのメンバーを更新する
スペースの使用状況を取得する
スペースのスレッドを作成する
スペースのスレッドを更新する
スペースのスレッドにコメントを投稿する
ゲストユーザーを追加する
ゲストユーザーを削除する
ゲストスペースのゲストメンバーを更新する
ファイルをダウンロードする
ファイルをアップロードする
インストール済みのプラグインの一覧を取得する
インストールが必要なプラグインの一覧を取得する
プラグインを追加しているアプリの一覧を取得する
プラグインを読み込む
プラグインを更新する
プラグインをアンインストールする
kintone REST APIの一覧を取得する
kintone REST APIのスキーマ情報を取得する
kintone JavaScript APIの共通仕様
イベント処理の記述方法
イベントオブジェクトで実行できる操作
レコード一覧画面を表示した後のイベント
レコード一覧画面のインライン編集を開始したときのイベント
レコード一覧画面のインライン編集でフィールドの値を変更したときのイベント
レコード一覧画面のインライン編集で保存するときのイベント
レコード一覧画面のインライン編集に成功したときのイベント
レコード一覧画面でレコードを削除する前のイベント
レコード詳細画面を表示した後のイベント
レコード詳細画面でレコードを削除する前のイベント
プロセス管理でアクションを実行するときのイベント
レコード追加画面を表示した後のイベント
レコード追加画面でフィールドの値を変更したときのイベント
レコード追加画面で保存するときのイベント
レコード追加画面で保存に成功した後のイベント
レコード編集画面を表示した後のイベント
レコード編集画面でフィールドの値を変更したときのイベント
レコード編集画面で保存するときのイベント
レコード編集画面で保存に成功した後のイベント
グラフ画面を表示した後のイベント
レコード印刷画面を表示した後のイベント
ポータル画面を表示した後のイベント
スペースのポータル画面を表示した後のイベント
ログインユーザーの情報を取得する
ログインユーザーの個人設定を取得する
ユーザーが所属する組織を取得する
ユーザーが所属するグループ（ロール）を取得する
ユーザーのカスタマイズ項目を取得する
ログインユーザーがcybozu.com共通管理者かどうかを取得する
ユーザーのアイコンを取得する
デザインのバージョンを取得する
cybozu.comの他のサービスを利用可能かどうかを取得する
ドメイン情報を取得する
利用可能なAPIの種類を取得する
セキュアアクセスかどうかを取得する
モバイルアプリからのアクセスかどうかを取得する
モバイル版の画面かどうかを取得する
フロントエンド基盤の刷新後の画面かどうかを取得する
表示中の画面を取得する
確認ダイアログを表示する
ダイアログを作成する
画面上部にメッセージを表示する
ローディングを表示する
kintone内の画面のURLを組み立てる
ショートカットキーの有効／無効を切り替える
ショートカットキーの有効／無効の状態を取得する
アプリ情報を取得する
アプリのIDを取得する
アプリのフィールド情報を一括取得する
アプリのフォームのレイアウトを取得する
アプリの動作テスト環境かどうかを取得する
アプリがメンテナンスモードかどうかを取得する
アプリの説明の開閉を切り替える
アプリの説明の表示状態を取得する
アプリのアイコンのURLを取得する
レコード一覧のフィールド要素を取得する
レコード一覧のメニューの右側の要素を取得する
レコード一覧のメニューの下側の要素を取得する
レコード一覧の設定を取得する
レコード一覧の一覧を取得する
レコード一覧のクエリ文字列を取得する
レコード一覧のクエリ文字列を取得する（オプション付き）
ヘッダーの下側の要素を取得する
ルックアップフィールドの参照先のアプリIDを取得する
URL内のクエリで、表示するレコードの条件を指定する
関連レコード一覧の参照先のアプリIDを取得する
プロセス管理の設定を取得する
実行可能なプロセス管理のアクションの一覧を取得する
プロセス管理の現在の作業者を取得する
カテゴリーの設定情報を取得する
ログインユーザーのアプリに対するアクセス権を取得する
レコードIDを取得する
レコードの値を取得する
レコードに値をセットする
フィールド要素を取得する
スペースフィールドの要素を取得する
グループフィールドを開閉する
グループフィールドの開閉状態を取得する
メニューの上側の要素を取得する
ログインユーザーのレコードに対するアクセス権を取得する
ログインユーザーのレコードのフィールドに対するアクセス権を取得する
レコードのステータスの履歴を取得する
実行可能なアプリのアクションの一覧を取得する
フィールドの表示／非表示を切り替える
フィールドの表示／非表示の状態を取得する
レコードの追加ボタンの表示／非表示を切り替える
レコード追加ボタンの表示状態を取得する
レコードの編集ボタンの表示／非表示を切り替える
レコード編集ボタンの表示状態を取得する
レコードの再利用ボタンの表示／非表示を切り替える
レコード再利用ボタンの表示状態を取得する
アプリの設定ボタンの表示／非表示を切り替える
アプリ設定ボタンの表示状態を取得する
アプリのオプションボタンの表示／非表示を切り替える
アプリのオプションボタンの表示状態を取得する
前／次のレコードに移動するボタンの表示／非表示を切り替える
前／次のレコードに移動するボタンの表示状態を取得する
サイドバーの開閉を切り替える
サイドバーの表示状態を取得する
絞り込みボタンの表示／非表示を切り替える
絞り込みボタンの表示状態を取得する
集計ボタンの表示／非表示を切り替える
集計ボタンの表示状態を取得する
一覧とグラフを選択するパーツの表示／非表示を切り替える
一覧とグラフを選択するパーツの表示状態を取得する
一覧を選択するパーツの表示／非表示を切り替える
一覧を選択するパーツの表示状態を取得する
グラフを選択するパーツの表示／非表示を切り替える
グラフを選択するパーツの表示状態を取得する
アプリのアクションボタンの表示／非表示を切り替える
アプリのアクションボタンの表示状態を取得する
プロセス管理のアクションボタンの表示／非表示を切り替える
プロセス管理のアクションボタンの表示状態を取得する
スペース情報を取得する
スペースのポータル画面の上側の要素を取得する
ログインユーザーのスペースに対するアクセス権を取得する
機能の有効化状況を取得する
ログインユーザーのシステムに対する権限を取得する
試用中かどうかを取得する
kintoneの契約中のコースを取得する
kintone REST APIリクエストを送信する
APIのURLを取得する
クエリ文字列付きのAPIのURLを取得する
CSRFトークンを取得する
kintone REST API同時接続数を取得する
外部のAPIを実行する
外部にファイルをアップロードする
ポータルの上側の要素を取得する
プラグインの設定情報を取得する
プラグインの設定情報を保存する
外部APIの実行に必要な情報を取得する
外部APIの実行に必要な情報をプラグインへ保存する
プラグインから外部APIを実行する
プラグインから外部にファイルをアップロードする
kintone.Promiseを使用する（非推奨）
「ワイドコース専用API」とは
「APIラボ」とは
プロセス管理の設定を取得する
プロセス管理の設定を変更する
カテゴリーの設定情報を取得する
カテゴリーの設定情報を変更する
アプリに追加されているプラグインの設定情報を取得する
アプリに追加されているプラグインの設定情報を変更する
アプリの一般設定を取得する（取得できる項目が増える）
アプリの一般設定を取得する（「レコード一覧でのインライン編集」の設定を取得できる）
アプリの一般設定を変更する（変更できる項目が増える）
アプリの一般設定を変更する（「レコード一覧でのインライン編集」の設定を変更できる）
アプリ管理者用メモを取得する
アプリ管理者用メモを変更する
アプリに追加されているプラグインの一覧を取得する
アプリにプラグインを追加する
アプリの所属するスペースを変更する
スペースを作成する
スペースの情報を取得する（取得できる項目が増える）
スペースの設定を変更する
スペースのスレッドを作成する
複数のレコードを更新する（UPSERTモードを利用できる）
インストール済みのプラグインの一覧を取得する
インストールが必要なプラグインの一覧を取得する
プラグインを読み込む
プラグインを更新する
プラグインをアンインストールする
対象のプラグインを追加しているアプリの一覧を取得する
サイドバーを表示する
サイドバーを非表示にする
レコード追加ボタンの表示・非表示を変更する
レコード編集ボタンの表示・非表示を変更する
ログインユーザーのアプリに対するアクセス権を取得する
ログインユーザーのレコードに対するアクセス権を取得する
アプリ情報を取得する
スペース情報を取得する
アプリのアイコンのURLを取得する
プラグインの新しい開発方式

kintone API共通

クエリの書き方、フィールド形式などのkintone API共通仕様です。

kintone APIのアップデートおよび提供に関する方針

cybozu.comが提供するkintone APIのアップデートおよび提供に関する方針です。

フィールド形式

kintoneのフィールド形式について説明します。

クエリの書き方

レコードを絞り込むときのクエリの書き方を説明します。

kintone Webhook

kintoneのWebhookについて説明します。