ページネーション

一覧取得で使うページネーションの基本をまとめます。

​

概要

一覧APIは page と limit を使います。レスポンスの page / count / total を見ながらページを進めます。

​

パラメータ

例: 受注一覧の取得

curl -X GET "https://api.sanka.com/v1/public/orders?page=1&limit=50" \
  -H "Authorization: Bearer <access_token>"

• page: 取得するページ番号
• limit: 1ページあたりの件数

​

レスポンスの見方

{
  "data": [ ... ],
  "page": 1,
  "count": 50,
  "total": 240,
  "message": "success"
}

page * count < total の間は次のページが存在します。