kintone APIドキュメント

1件のレコードを取得する

目次

1件のレコードを取得する

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

レコードIDを指定して1件のレコード内容を取得します。
複数のレコードを取得する場合は次のAPIを参照してください。
レコードを複数取得する

URL

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

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

HTTPメソッド

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

GET

必要なアクセス権

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

  • アプリのレコード閲覧権限
  • 値を取得するレコードの閲覧権限
  • 値を取得するフィールドの閲覧権限

リクエスト

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

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

https://sample.cybozu.com/k/v1/record.json?app=8&id=100

ヘッダー
1
2
3

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

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

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

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

ヘッダー
1
2
3
4

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

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

ボディ
1
2
3
4

{
  "app": 8,
  "id": 100
}

レスポンス

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

プロパティ
プロパティ名 型 説明
record オブジェクト 取得したレコードの情報
フィールドの形式は次のページを参照してください。
フィールド形式

サンプルコード

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

curlを使ったリクエスト
1
2

curl -X GET 'https://sample.cybozu.com/k/v1/record.json?app=1&id=2' \
  -H 'X-Cybozu-API-Token: API_TOKEN'
kintone.api()を使ったリクエスト

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

1
2
3
4
5
6

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

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

補足

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

  • レコードのデータの言語は認証方式によって決まります。

    • APIトークン認証：「Administrator」の表示言語
    • それ以外の認証方式：APIを実行したユーザーの表示言語

    言語設定が「Webブラウザーの設定に従う」の場合、リクエストヘッダーの「Accept-Language」の有無によって、取得する言語が変わります。
    リクエストヘッダー

    • ヘッダーあり：「Accept-Language」ヘッダーで指定した言語
    • ヘッダーなし：cybozu.com共通管理のロケールの設定で設定した言語
      ロケールの設定 (External link)