一覧を取得するAPIリクエスト時に下記のパラメータを指定することができます。
| パラメータ名 | 説明 | タイプ |
|---|---|---|
limit |
返す数を1〜100の範囲で指定することができます。デフォルトは10です。 | number |
startingAfter |
一覧を取得する際に、先頭のオブジェクトIDを指定します。返ってくる一覧は、このIDの次のオブジェクトからとなります。この動きは、次のページを取得したい場合に、前回取得した一覧の最後のIDを指定すればよいことになります。 | string |
endingBefore |
一覧を取得する際に、最後のオブジェクトIDを指定します。返ってくる一覧は、このIDの前のオブジェクトからとなります。この動きは、前のページを取得したい場合に、前回取得した一覧の最初のIDを指定すればよいことになります。 | string |
APIリクエスト結果に下記のパラメータが含まれています。
| パラメータ名 | 説明 | タイプ |
|---|---|---|
hasMore |
次のページがあるかどうかのフラグ | boolean |
totalCount |
オブジェクトの総数 | number |