クエリで条件を指定して、複数のレコードを取得します。

| HTTPメソッド | GET |
| URL | https\://sample.cybozu.com/k/v1/records.json |
| URL（ゲストスペース）| https\://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/records.json |
| 認証 | [パスワード認証](/id/edae2a9d04c6e7d0afffda3a/#password), [APIトークン認証](/id/edae2a9d04c6e7d0afffda3a/#api-token), [セッション認証](/id/edae2a9d04c6e7d0afffda3a/#session), [OAuth認証](/id/edae2a9d04c6e7d0afffda3a/#oauth) |
| Content-Type | 不要（リクエストボディにパラメーターを含める場合はapplication/json）|

### リクエストパラメーター

| パラメーター名 | 型 | 必須 | 説明 |
| :-- | :-- | :-- | :-- |
| app | 数値または文字列 | 必須 | アプリID |
| fields | 文字列の配列 | 省略可 | レスポンスに含めるフィールドコード<br>省略すると、閲覧権限のあるすべてのフィールドの値が返ります。<br>リクエストボディで`fields`を指定する場合、指定できるフィールドコードの数は1,000件までです。<br>クエリ文字列で`fields`を指定する場合、`fields`に指定できる添字は、0から99までです。 <br>テーブル内のフィールドは指定できません。<br>テーブル内のフィールドを取得する場合は、テーブルフィールドのフィールドコードを指定します。テーブル内のフィールドがすべて取得されます。|
| query | 文字列 | 省略可 | レスポンスに含めるレコードの条件を指定するクエリ文字列<br>クエリ記法の詳細は次のページを参照してください。<br>[クエリの書き方](/kintone/docs/overview/query/)<br>省略すると、閲覧権限のあるすべてのレコードを取得します。 |
| totalCount | 真偽値または文字列 | 省略可 | `query`で指定した条件に一致するレコードの件数を取得するかどうか<ul><li>`true`：件数を取得する</li><li>`false`：件数を取得しない</li></ul> |

### レスポンスプロパティ

| プロパティ名 | 型 | 説明 |
| :-- | :-- | :-- |
| records | 配列（オブジェクト） | レコードの一覧<br>フィールドの形式は次のページを参照してください。<br>[フィールド形式](/id/2736678ef8d2aad09a33e8bb/) |
| totalCount | 文字列 | レコードの件数<br>リクエストパラメーターの`totalCount`に「false」を指定または省略した場合、「null」が返ります。 |

### 必要なアクセス権

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

### サンプル

URLエンコードしたパラメーターをHTTPのクエリ文字列として送信します。たとえば、次のパラメーターを指定するとします。

```plaintext
app=1&query=更新日時 > "2012-02-03T09:00:00+0900" and 更新日時 < "2012-02-03T10:00:00+0900" order by レコード番号 asc limit 10 offset 1&fields[0]=レコード番号&fields[1]=作成日時&fields[2]=ドロップダウン
```

この場合のURLは、次のようになります。

```plaintext
https://sample.cybozu.com/k/v1/records.json?app=1&query=%e6%9b%b4%e6%96%b0%e6%97%a5%e6%99%82%20%3E%20%222012-02-03T09%3A00%3A00%2B0900%22%20and%20%e6%9b%b4%e6%96%b0%e6%97%a5%e6%99%82%20%3C%20%222012-02-03T10%3A00%3A00%2B0900%22%20order%20by%20%e3%83%ac%e3%82%b3%e3%83%bc%e3%83%89%e7%95%aa%e5%8f%b7%20asc%20limit%2010%20offset%201&fields%5B0%5D=%e3%83%ac%e3%82%b3%e3%83%bc%e3%83%89%e7%95%aa%e5%8f%b7&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
```

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

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

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

```js
const body = {
  app: kintone.app.getId(),
  query: '更新日時 > "2025-02-03T09:00:00+0900" and 更新日時 < "2025-02-03T10:00:00+0900" order by レコード番号 asc limit 10 offset 1',
  fields: ['レコード番号', '作成日時', 'ドロップダウン']
};

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

ご利用の環境によって、curlのフォーマットは異なる場合があります。  
詳細は、次のページを参照してください。  
[curlコマンドでkintone REST APIを実行してみよう/3.API実行](/id/49f27ea50d9f50901cdef93f/#api-execution-to-post)

```shell
curl -X GET 'https://sample.cybozu.com/k/v1/records.json?app=1&query=%e6%9b%b4%e6%96%b0%e6%97%a5%e6%99%82%20%3E%20%222012-02-03T09%3A00%3A00%2B0900%22%20and%20%e6%9b%b4%e6%96%b0%e6%97%a5%e6%99%82%20%3C%20%222012-02-03T10%3A00%3A00%2B0900%22%20order%20by%20%e3%83%ac%e3%82%b3%e3%83%bc%e3%83%89%e7%95%aa%e5%8f%b7%20asc%20limit%2010%20offset%201&fields%5B0%5D=%e3%83%ac%e3%82%b3%e3%83%bc%e3%83%89%e7%95%aa%e5%8f%b7&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' \
  -H 'X-Cybozu-API-Token: API_TOKEN'
```

### 補足

- 一度に取得できるレコードは、500件までです。  
  取得できるレコード数は、`query`パラメーターの`limit`で指定します。  
  [`query`パラメーターの`limit`](/id/b05ff19d869f1609a1326dc7/#option)  
  `limit`の初期値は、100件です。
- `query`パラメーターの`offset`の上限値は10,000件です。  
  [`query`パラメーターの`offset`](/id/b05ff19d869f1609a1326dc7/#option)
- クエリで文字列を検索する場合は単語検索です。詳しくは次のページを参照してください。  
  [キーワード入力時の注意事項](https://jp.kintone.help/k/ja/id/040689#search_search_details_60)
- 絞り込み条件にキーワード検索（like, not like）を使用する場合、キーワードを含むレコードが100,000件に達した時点で検索を打ち切ります。  
  その場合、レスポンスヘッダーの「X-Cybozu-Warning」に「Filter aborted because of too many search results」が追加されます。
- レコードのデータの言語は認証方式によって決まります。
  - APIトークン認証：「Administrator」の表示言語
  - それ以外の認証方式：APIを実行したユーザーの表示言語

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

  - ヘッダーあり：「Accept-Language」ヘッダーで指定した言語
  - ヘッダーなし：cybozu.com共通管理のロケールの設定で設定した言語<br>[ロケールの設定](https://jp.kintone.help/general/ja/id/020113)
- 「GET」リクエストの使い方の中、最も一般的な方法は「URLにパラメーターを含める」です。  
  その他のリクエストの方法や、詳細は次のページを参考にしてください。  
  [REST APIでGETを使う3つの方法とその使い分けについて](/id/4708c9beff3daa99eb7d5f16/)