Skip to main content
Most list endpoints take a limit and return 10 rows when you omit it. There are four shapes, and a missing pagination object reads as “no more results”. Read the shape off the response, not off the resource. The table at the end says which endpoint uses which.

The four shapes

The rows always come back under a key named for the resource — data, payouts, recipients. What changes is what sits beside them.

An offset object

Takes limit and offset, and wraps the rows with a pagination object.
Walk it by adding limit to offset until has_more is false. total counts the rows matching your filters, not the rows on this page.

Numbered pages

Takes limit and page, counting from 1, and puts the counters at the top level beside the rows.
There is no has_more here. Stop when page reaches total_pages.

A bare array

Takes limit and offset and returns the rows with nothing around them:
No total, no has_more. You have reached the end when you get back fewer rows than the limit you asked for.

A total with no paging

Returns every row and a total, and takes no limit, offset or page. Sending one changes nothing.

The parameters

Which endpoint uses which