Syntext DOCS
Get Started
API Pagination

Pagination

List endpoints that can return many items accept page and pageSize query parameters and return a pagination object alongside the data.

Request

The page number, starting at 1.

Items per page.

curl "https://api.syntext.dev/v1/projects/prj_abc123/builds?page=2&pageSize=50" \
  -H "Authorization: Bearer stx_abc12345_..."

Response

{
  "data": [
    { "id": "bld_123", "status": "deployed", "...": "..." }
  ],
  "pagination": {
    "page": 2,
    "pageSize": 50
  }
}

Results are ordered newest first. To fetch everything, increment page until a request returns fewer than pageSize items.

Paginated Endpoints

  • List Buildspage, pageSize
  • List Projects
  • Feedback, discussions, playground history, and access logs use the same pattern

SDK Example

const { data, pagination } = await client.builds.list('prj_abc123', {
  page: 1,
  pageSize: 50,
})

Endpoints with naturally bounded result sets (API keys, domains, audiences) return all items without pagination.

Assistant
Responses are generated using AI and may contain mistakes.

Ask me anything about the documentation.

ESC