Skip to main content

Paginating API Request Results

Page through record lists with limit (default 100, maximum 1,000) and offset; each response reports total, offset, limit and items.

Written by Peter Novosel

The list records endpoint returns records in pages. Set limit to choose the page size (100 by default, 1,000 at most) and offset to skip the records already fetched; each response reports total, offset, limit and the items on that page. Each page is one API request against the monthly allowance.

Plan Availability

All plan types. Every request counts toward the workspace's monthly API allowance: 25,000 on Team, 100,000 on Professional, 500,000 on Enterprise, custom on Signature.

Permissions

Any member with an API key. The key acts with that member's role and permissions, as the REST API Permissions article describes.

Platform

API

Related Reading

My list request fails or stops early: check these four things, in order

Any member with an API key can page records; the key acts with that member's permissions. If the requests fail for everyone, send this page to your workspace Administrator.

  1. A page over 1,000. limit accepts up to 1,000; the default is 100. See What are the limits?.

  2. A 429 error. Requests above 5 per second per member are refused; wait 30 seconds. See What are the limits?.

  3. The loop stopped early. Add the page size to offset each time until the offset reaches total. See How do I fetch the next page?.

  4. The monthly allowance. Every page is one request against it. See What are the limits?.

Still stuck: select the chat button in the lower-right corner of SmartSuite. The last block of the panel shows the service status, and Send a message in the same panel reaches support. Include the table id, the limit and offset values and the response code. Usage and how to reduce it are in Check and reduce API usage.


How do I set the page size?

Add limit to the request URL. This request returns the first 100 records:

POST https://app.smartsuite.com/api/v1/applications/[tableId]/records/list/?limit=100

How do I fetch the next page?

Add offset, the number of records to skip. This request skips the first 100 and returns the next 100:

POST https://app.smartsuite.com/api/v1/applications/[tableId]/records/list/?offset=100&limit=100

Repeat, adding the page size to the offset each time, until the offset reaches the total.


What does the response contain?

{   "total": 5000,   "offset": 0,   "limit": 100,   "items": [     ...   ] }

Property.

Meaning.

total.

The number of records that match the request.

offset.

Where this page starts.

limit.

The maximum number of items in this page.

items.

The records on this page.


What are the limits?

  • limit defaults to 100 and accepts up to 1,000.

  • Requests above 5 per second per member return a 429 error; wait 30 seconds and retry.

  • Each page counts as one request toward the monthly allowance.


Frequently asked questions

The first question came from conversations this month; the other two are from the developer documentation and the Limits article.

Does every page I fetch count toward my API allowance?

Yes. Each list request is one API request, whatever its page size, so a table of 5,000 records fetched 100 at a time costs 50 requests and fetched 1,000 at a time costs 5. Administrators see the month's total in Workspace Administration > Usage.

What is the largest page I can request?

1,000 records. The developer documentation states the limit value must be 1,000 or less.

What happens if I page too fast?

Requests above 5 per second per member return a 429 Too Many Requests error. Pause 30 seconds before retrying.

Last verified 26 Oct 2026.

Did this answer your question?