API API Reference Pagination
Pagination
How list endpoints paginate results in the Syntext API.
List Builds accepts page and pageSize query parameters and returns a pagination object alongside the data. Other lists use the styles in the table below.
Request
NameDescription
pageThe page number, starting at 1.
Default
1pageSizeItems per page, up to 100.
Default
20bash
curl "https://api.syntext.dev/v1/projects/$PROJECT_ID/builds?page=2&pageSize=50" \
-H "Authorization: Bearer $SYNTEXT_API_KEY"
Response
json
{
"data": [
{ "id": "bld_123", "status": "deployed", "...": "..." }
],
"pagination": {
"page": 2,
"pageSize": 50,
"total": 137
}
}
Results are ordered newest first. To fetch everything, increment page until page × pageSize reaches total.
Paginated Endpoints
•
Other lists use other styles:
| Style | Endpoints |
|---|---|
limit and offset, with a top-level total | Documentation gaps, glossary (meta.total; without limit every term is returned) |
Cursor — startingAfter and a top-level hasMore | List Invoices |
limit only, newest first | Run history, access logs |
| Fixed — the 10 most recent | Playground history |
page and limit, with top-level hasMore and total | Audit log |
Note
Endpoints with naturally bounded result sets (projects, API keys, domains, audiences, page feedback, discussions) return all items without pagination.
Was this page helpful? Yes No
Previous
Next