# ページネーション

一覧取得系のAPIは大量データの送信を防ぐためにページング機能が実装されています。\
取得対象の件数が10件以上の場合、デフォルトでは最大10件まで取得します。\
以降のデータを取得したい場合や10件以上のデータを取得したい場合、クエリパラメータでpageやlimitを指定することで取得できます。\
また、取得したいデータを絞るために検索条件を指定することができます。検索できる項目は各APIによって異なります。

| No | 項目名               | パラメータ    | 内容                               | デフォルト             | 範囲       | 処理条件                                                                                                       |
|----|----------------------|---------------|------------------------------------|------------------------|------------|---------------------------------------------------------------------------------------------------------------|
| 1  | 取得件数             | limit         | 1ページの最大件数                 | 10                     | 10-100     | 指定されない場合デフォルト値が適用されます。<br>データ範囲外はエラーになります。                                                                    |
| 2  | ページ               | page          | ページ数                           | 1                      | 1-9999     | 指定されない場合デフォルト値が適用されます。<br>レスポンスのlast_page（最終ページ）より大きい数字を指定した場合はエラーを返却します。             |
| 3  | 総件数のみフラグ     | count_only    | 総件数のみを取得する               | false                  | -          | trueが指定された場合は、指定された条件に合致するレコード総件数のみをレスポンスとして返却します。                                                    |
| 4  | ソート               | sort          | ソート順の定義                     | APIのデフォルト値      | -          | sort=項目名1 [asc \| desc], 項目名2 [asc \| desc], …<br>例) sort=customer_id asc, customer_name asc, customer_email desc<br>指定がない場合は各API デフォルトのソート順となります。<br>指定された項目がないまたはフォーマットが不正な場合はエラーになります。<br>総件数のみフラグがtrueの場合、このリクエストは無視されます。 |

### サンプル①
[顧客 一覧取得API](https://docs.fincode.jp/api#tag/%E9%A1%A7%E5%AE%A2/operation/retrieveCustomerList)で顧客IDを昇順にソートして、2ページ目のデータを取得する例
```txt
https://api.test.fincode.jp/v1/customers?page=2&sort=id asc
```

### サンプル②
[顧客 一覧取得API](https://docs.fincode.jp/api#tag/%E9%A1%A7%E5%AE%A2/operation/retrieveCustomerList)で検索条件で作成日を2023/06/28に限定して、2ページ目のデータを取得する例
```txt
https://api.test.fincode.jp/v1/customers?page=2&created_from=2023/06/28&created_to=2023/06/28
```

### サンプル③
[顧客 一覧取得API](https://docs.fincode.jp/api#tag/%E9%A1%A7%E5%AE%A2/operation/retrieveCustomerList)で顧客の総件数のみを取得する例
```txt
https://api.test.fincode.jp/v1/customers?count_only=true
```