kintone API ドキュメント

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

目次

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

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

URL

通常のアプリ
https://sample.cybozu.com/k/v1/record.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペース 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 REST API リクエストを送信する 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);