メインコンテンツへスキップ
Organization API および Enterprise API のすべてのリスト系エンドポイントでは、カーソルベースのページネーションを使用します。これにより、結果セットのサイズにかかわらず、一貫性があり効率的なページネーションが可能になります。

仕組み

すべてのリストエンドポイントは、2 つのクエリパラメータを受け取ります。
ParameterTypeDescription
firstinteger1 ページあたりに返す項目数の上限(デフォルト値はエンドポイントごとに異なります)
afterstring前のレスポンスで返された不透明なカーソル。最初のページでは省略します

レスポンス形式

リスト形式のレスポンスには、ページネーション用のメタデータが含まれます:
FieldDescription
items現在のページの結果の配列
has_next_page追加の結果がある場合は true
end_cursor次のページを取得するために、これを after パラメータとして渡します。has_next_pagefalse の場合は null
total一致するアイテムの総数(一部のエンドポイントではパフォーマンス上の理由で省略される場合があります)

例: セッションのページング

最初のページ

次のページ

前のレスポンスの end_cursor の値を使用してください:

全件の結果を取得する

オフセットベースのページネーションからの移行

API v1 または v2 から移行する場合は、offset/limitafter/first に置き換えてください。
カーソルベースのページネーションは、ページ間でアイテムが追加・削除されても影響を受けないため、オフセットベースのページネーションよりも信頼性が高くなります。