ページネーション

オブジェクトのリストを返す GET リクエストは、ページ処理をサポートする場合があります。ページネーションは、カーソルではなくページ番号に基づいて行われます。リクエストを行う際、特定のサイズの特定のページを返すために、 page と limit パラメータをリクエストに追加します。ページネーションされたデータを返すには、両方のパラメータを指定する必要があります。

パラメータ	説明	タイプ
page	返すページ番号	整数
limit	返却個数	整数

例：

cURL

curl-H'Authorization: Token API_KEY' https://api.foxpass.com/v1/groups/?page=1&limit=10

 

FoxpassのAPIは、これらの項目とともに、以下のページオブジェクトを返します。

パラメータ	説明	タイプ
page	ページ番号が返されました	整数
limit	返品数	整数
next	次のページにさらにアイテムが存在するかどうか	ブール値

例

cURL

{"status": "ok", "data": [...], "page": {"page": 1, "limit": 10, "next": true}}

 

 

両方のページパラメータが送信されない場合、Foxpassは完全なpageオブジェクトではなく、nullオブジェクトを返します。