kintone REST APIは、kintoneのアプリやレコード、スペースを操作できるAPIです。
このページでは、kintone REST APIの共通仕様を説明します。
各APIの仕様の詳細は、それぞれのAPIのページを確認してください。

APIによって異なります。

RESOURCEは、APIによって異なります。
詳細は各APIのページを確認してください。

通常（ゲストスペース以外）

https://sample.cybozu.com/k/v1/RESOURCE

ゲストスペース

https://sample.cybozu.com/k/guest/SPACE_ID/v1/RESOURCE

送信するリクエストに応じて次のリクエストヘッダーを指定します。
kintone REST API リクエストを送信する APIを使って、kintone REST APIを実行する場合、リクエストヘッダーの指定は不要です。

curl -X POST https://sample.cybozu.com/k/v1/records.json \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json'  \
  -H 'X-HTTP-Method-Override: GET' \
  -d '{ "app": 1, "query": "更新日時 > \"2012-02-03T09:00:00Z\"" }'

JSON形式で指定します。文字コードはUTF-8です。
ただし、 ファイルをアップロードする APIはマルチパート形式で指定します。

JSON文字列でエスケープが必要な文字は、\でエスケープしてください。

GETメソッドのAPIでは、URLのクエリパラメーターとしてリクエストパラメーターを付与し、リクエストを送信できます。
たとえばリクエストパラメーターのappが「1」の場合、クエリパラメーターは次のように指定します。

1

/k/v1/records.json?app=1

エスケープ

URLの仕様に従い、クエリパラメーターのキーや値はパーセントエンコーディングします。
以下は、クエリパラメーターの「更新日時 > "2021-10-01T09:00:00+0900"」をパーセントエンコーディングした例です。

1

/k/v1/records.json?app=1&query=%e6%9b%b4%e6%96%b0%e6%97%a5%e6%99%82%20%3E%20%222021-10-01T09%3A00%3A00%2B0900%22%20

配列型のパラメーターを指定する場合

配列を要素に分解してパーセントエンコーディングします。

リクエストパラメーターのfieldsに、「レコード番号」と「ドロップダウン」を指定する例を示します。

1. fields=[レコード番号,ドロップボックス]という配列を要素に分解します。

   1	/k/v1/records.json?app=1&fields[0]=レコード番号&fields[1]=ドロップダウン

2. クエリパラメーターのキーや値をパーセントエンコーディングします。

   1	/k/v1/records.json?app=1&fields%5B1%5D=%e4%bd%9c%e6%88%90%e6%97%a5%e6%99%82&fields%5B2%5D=%e3%83%89%e3%83%ad%e3%83%83%e3%83%97%e3%83%80%e3%82%a6%e3%83%b3

リクエストに成功した場合、200番台のステータスコードが返ります。
リクエストに失敗した場合、200番台以外のステータスコードと、次のプロパティをもつオブジェクトが返ります。

パラメーター名	型	説明
id	文字列	エラー ID サポートへの問い合わせの際に利用します。
code	文字列	エラーの種類を表すコード
message	文字列	エラーメッセージ 出力されるメッセージの言語は、API を実行したユーザーの 表示言語の設定 によって異なります。

エラーの例

1
2
3
4
5

{
  "id": "1505999166-897850006",
  "code": "CB_IJ01",
  "message": "不正なJSON文字列です。"
}

kintone REST API リクエストを送信する API で実行した場合

kintone REST API リクエストを送信する APIを使って、kintone REST APIを実行した場合、コールバック関数に渡される情報は、レスポンスボディだけです。
レスポンスボディ以外の情報を利用する場合には、 kintone REST API リクエストを送信する API以外の方法で、kintone REST APIを実行してください。

JSON形式で返されます。文字コードはUTF-8です。
ただし、 ファイルをダウンロードする APIでは、バイナリデータが返されます。

日時を扱うフィールドでは、次の形式の文字列を指定してください。

フォーマット

YYYY-MM-DD

補足

次の形式も許容されます。

• YYYY（例：2015）
• YYYY-MM（例：2015-07）
• YYYY-M（例：2015-7）
• YYYY-M-D（例：2015-7-5）

月日を省略すると01で補完され、桁数が足りない場合は0埋めされます。

• 2015 → 2015-01-01
• 2015-07 → 2015-07-01
• 2015-7 → 2015-07-01
• 2015-7-5 → 2015-07-05

フォーマット

HH:MM

補足

UTCには変換されません。

フォーマット

YYYY-MM-DDTHH:MM:SSZ

補足

たとえば、日本時間（JST）の2012年3月22日14時00分は、「2012-03-22T05:00:00Z」と表します。
「YYYY-MM-DD」と「HH:MM:SS」の間の「T」や、「HH:MM:SS」の後ろの「Z」は固定値です。
「Z」はUTCを表します。

「T」以降を省略すると、UTCとして扱われます。

一覧の設定を取得する APIでは、日時はUTCで出力されます。

フォーマット

YYYY-MM-DDTHH:MM:SS±HH:MMまたはYYYY-MM-DDTHH:MM:SSZ

補足

たとえば、日本時間（JST）の2012年3月22日14時17分は、次のように表します。
「2012-03-22T14:17:00+09:00」「2012-03-22T05:17:00Z」

「YYYY-MM-DD」と「HH:MM:SS」の間の「T」や、「HH:MM:SS」の後ろの「Z」は固定値です。

「±HH:MM」には、UTCとの時刻の差を指定します。

「T」以降を省略すると、UTCとして扱われます。

秒情報を指定して登録または更新を行と、秒情報は無視されます。
たとえば、「2019-02-06T12:59:59Z」と指定すると、「2019-02-06T12:59:00Z」として登録または更新されます。

• リクエストデータ、およびレスポンスデータのJSONフォーマットには、今後フィールドやキーなどが追加される場合があります。
• REST APIを実行すると監査ログに記録されます。詳細は kintoneの監査ログの確認方法／ログ一覧 を参照してください。
• 1日に実行できるAPIは、1つのアプリにつき10,000件までです。
  リクエスト数にカウントされないAPIは、 1日に実行できるAPIリクエスト数 を確認してください。

同時にリクエストできるAPIは、1ドメインにつき100までです。

• 複数のレコードを取得する APIのoffsetで指定できるレコードの上限数は、10,000件までです。
• 一度に登録／更新／削除できるレコードは、100件までです。
• 1つのテーブルに大量の行を追加しないでください。
  アプリの構成によっては負荷がかかり、レコードの表示やREST APIを使った操作などのレコードの処理に影響します。
  kintoneの性能を考慮したレコードの操作方法は、 kintone の性能改善を参照してください。
• 存在しないフィールドコードを指定して、レコードを取得／登録／更新した場合でも、存在しないフィールドコードは無視されて処理されます。
• 次のフィールドは、値の取得のみです。登録や更新はできません。
  • ルックアップフィールドによって値が入力されるフィールド
  • カテゴリー
  • 計算
  • ステータス
    更新する場合は、 レコードのステータスを更新する APIを使います。
  • 作業者
    更新する場合は、 レコードの作業者を更新する APIを使います。
• レコードの登録や更新をするAPIでルックアップフィールドの値を変更する場合、ルックアップフィールドの「コピー元のフィールド」は、「レコード番号」フィールド、または「値の重複を禁止する」を設定したフィールドを指定してください。
• ルックアップフィールドの「コピー元のフィールド」に、自動計算を設定している「文字列1行」フィールドを選択している場合、ルックアップフィールドの値は変更できません。

アップロードしたファイルは、一時保管領域に保存されます。
レコードの登録や更新をするAPIでレコードに添付しない限り、3日間で削除されます。
一時保管領域に保存したファイルは、ディスク使用量に含まれます。

一度に取得できるレコードのコメントは10件までです。

• kintoneに関するその他の制限事項は、 制限値一覽 を確認してください。
• その他、サービスに関する制限事項は、 サイボウズのクラウドサービス制限事項 を確認してください。