ページネーション

リストとして返されるすべてのリソースはページネートされ、最新のものが最初となるように、そのリソースの作成日の降順でソートされます。ページあたりのアイテムの件数はデフォルトで 10 件です。 ページネートされたリストは以下のような形式となります。

  • items (array) – リソースのリスト
  • has_more (boolean) – 表示されているリストの最後のリソースの次に更にリソースがあるかどうか。
{
  "items": [],
  "has_more": false
}

次ページのリソースを取得する

以下のパラメータを指定することでリストの次のページを取得することができます。

  • limit (number) – 10 – 100 の範囲の整数。返却するリソースの数。
  • cursor (string) – リソースの取得開始位置を指定する為のリソースのID。このリソースの次のリソースから取得します。このIDで指定したリソースはレスポンスには含まれません。
  • cursor_direction – リソースのソート順。asc (昇順) もしくは desc (降順)

例えば、以下のリクエストで最初の100個の課金(Charge)リソースを取得することができます。

curl -h 'Authorization: Bearer {secret}.{jwt}' https://api../charges?limit=100
{
  "items": [
    {
      "id": "4050058b-646a-4fae-8876-babf0dc0c3f0"
      ...
    },
    ...
    {
      "id": "34daac6d-63a8-485b-a9ea-75a2e24a258d"
      ...
    }
  ],
  "has_more": true
}

"has_more": true となっているので、さらにリソースがある事がわかります。
次の 100 件の課金を取得するには、リストの最後のリソースID 34daac6d-63a8-485b-a9ea-75a2e24a258d をリクエストパラメータの cursor として指定します:

curl -h 'Authorization: Bearer {secret}.{jwt}' https://api../charges?cursor=34daac6d-63a8-485b-a9ea-75a2e24a258d&limit=100