API Pagination

When to use

• The user needs to expose next/previous page navigation and page-size limits in an API response.
• The user must choose between offset/limit and cursor-based pagination for an API collection.
• The user needs to return a large collection from an API in pages rather than all at once.

When NOT to use

• Do not page a full bulk export where the client wants every row; stream the response or provide an async export job instead.
• Do not paginate a collection that is inherently small and bounded, such as a fixed list of a user's roles or a handful of settings.

Core guidance