REST pagination
Configure paginated REST queries for table/repeater data
Use pagination when an API returns list data in pages and you need reliable forward/backward navigation in app components.
Before you start
- Create and save a REST connection
- Create and validate a list query
- Confirm which pagination model the API uses
Pagination models
| Model | Typical request fields | Typical response fields |
|---|---|---|
| Page number | page, limit | totalPages, page, hasNext |
| Offset/limit | offset, limit | total, offset, count |
| Cursor | cursor, limit | nextCursor or bookmark token |
Configure query pagination
- Open query in API Editor
- Enable pagination
- Select pagination type and location
- Map request field names
- Map response field path for continuation token/page value
- Click Send repeatedly to validate progression
- Save query
Cursor-specific guidance
- Map to the API field that returns the next cursor token
- Verify token comes from raw response path expected by Budibase
- Ensure stable sort order to avoid duplicates/missed rows
Use paginated query in components
- Bind query (or data provider) to table/repeater
- Enable component pagination controls where applicable
- Validate first, next, previous, and final page behavior
Troubleshooting matrix
| Symptom | Likely cause | Fix |
|---|---|---|
| Always shows page 1 | Request page/cursor field not mapped | Re-check request field mapping |
| Stops after first page | Response continuation path incorrect | Correct response field path |
| Duplicate rows across pages | Non-deterministic API sorting | Add stable sort in API query |
| Missing rows | Offset/page-size mismatch | Verify API math and defaults |
Related guides
Updated 1 day ago