Stepthrough Start free

What is API pagination?

Quick answer

API pagination is when an API returns a long list in chunks, called pages, instead of all at once. Each response holds one page of results and a marker, such as a page number or a cursor, that you send back to get the next page.

Last updated

Take the free module →Module 16 of the free n8n Jump Start course, about 9 minutes. No account needed.

Updated · By Robert Breen

Why it matters for a small business

APIs page their results to stay fast and to stop one request from pulling millions of records. For a business user, the effect is simple: the first call is never the whole story. If a report needs every client, invoice or post from the last month, the workflow must keep asking for the next page until the API says there are no more. Skip that and your weekly report quietly covers only the first slice.

Pagination also sets the bill on a pay-per-call API. When each call is one page, fetching four pages costs four calls. That is good news for a daily summary, which only needs the newest page. It is worth checking before you loop through a large archive, because the cost and the run time grow with every page.

What one ProLevelMax response contains

FieldWhat it holds
itemsThe posts on this page
countHow many items came back
pageThe cursor for the next page
costWhat the call cost

In a real lesson: ProLevelMax in n8n: Keep Your Reddit Workflow Alive After the RSS Shutdown

In the ProLevelMax Reddit lesson, the Subreddit feed source is described as one page per call at $0.003 per call. Maya Chen at Tallgrass Books (made up) only wants the newest r/smallbusiness posts each morning, so she sorts by NEW and takes the first page. A Code node then trims it, and the AI reads 25 tidy posts.

The response comes back with items, count, page and cost, and the page value is the cursor for the next page. Maya never needs it for a daily summary. A team reading further back would send another call for each page, each one billed separately, so 4 pages would be 4 calls. The HTTP Request basics lesson uses a query parameter to ask for less instead.

The ProLevelMax console Overview with a $1.00 balance, no runs yet, and the sidebar with Data sources and API keys
The ProLevelMax console Overview with a $1.00 balance, no runs yet, and the sidebar with Data sources and API keys

Try this lesson free or read the step-by-step guide.

Common confusions

Pagination vs rate limit

Pagination splits one big answer into pages. A rate limit caps how many calls you may make in a period. A long loop through pages can hit the rate limit.

Page cursor vs page number

A page number says go to page 3. A cursor is a marker the API hands you that says continue from here, which stays correct even when new posts arrive in between.

Tips

  • Check the count field: if it is less than a full page, you probably have everything.
  • Set a maximum number of pages in any loop so a mistake cannot run up calls.
  • For daily jobs, sort newest first and stop after the first page.

More n8n and automation terms

Where you use it: free lessons

AI tools that use it

More terms by tool

Frequently asked questions

Why does my API only return some of the results?
It is probably paginated. The response holds one page and a marker for the next one, and you have to ask again to get the rest.
What is a cursor in an API?
A value the API sends back with each page that you return on the next call to continue where the last page ended.
Does each page cost money?
On a pay-per-call API, yes. ProLevelMax bills the Subreddit feed per call, and each call is one page.

All AI glossary terms, A to Z · Free prompt templates