Pagination & filtering

List endpoints return pages of results, not everything at once. The gateway passes paging and filter parameters straight through to the capability, so the exact names and limits are defined per endpoint — check the API Explorer for the one you're calling. Most follow the same conventions below; Storage and Search are the two exceptions.

Common conventions

curl "https://api.revenexx.com/v1/products?limit=50&order=created_at.desc" \
  -H "X-Revenexx-Tenant: <TENANT_SLUG>" \
  -H "X-Revenexx-Api-Key: rvxk_..."

A typical page response carries the items, the paging state and an echo of the filter that was applied:

{
  "items": [ /* ... */ ],
  "page": { "limit": 50, "offset": 0, "total": 248, "returned": 50, "hasMore": true },
  "filter": {}
}

page.limit is the size actually used: a limit above an endpoint's maximum is clamped, not refused.

Filtering

Filters are query parameters named after a field, and they match exactly:

curl "https://api.revenexx.com/v1/orders?number=ORD-000123" \
  -H "X-Revenexx-Tenant: <TENANT_SLUG>" \
  -H "X-Revenexx-Api-Key: rvxk_..."

• ?field=value is equality on that field. There is no substring search, no OR, no negation and no range.
• Several filters are ANDed.
• A parameter the endpoint doesn't know is ignored, not rejected. A typo such as ?stauts=pending returns 200 and the unfiltered list. Where the response carries a filter echo, read it to see what was actually applied; not every list returns one.

Operator prefixes such as ?status=eq.pending are not part of the public filter syntax. Write ?status=pending. Pagination and filtering in App Studio has the full rules for the lists an App serves.

Storage and Search use their own conventions

Two services don't take the limit/offset/order and ?field=value conventions above. Using them there is silently ignored, so match the service:

curl "https://api.revenexx.com/v1/storage/assets?filter[folder_id]=<FOLDER_ID>&sort=-created_at&limit=50&page=2" \
  -H "X-Revenexx-Tenant: <TENANT_SLUG>" \
  -H "X-Revenexx-Api-Key: rvxk_..."

On Storage, ?folder_id=... is an unknown parameter and is ignored, so it returns every asset. offset and order are ignored too. Storage's folder list isn't paged or filtered at all.

Paging through everything

For a service that uses limit and offset, increase offset by limit until page.hasMore is false — or, on an endpoint that doesn't return page, until a page holds fewer items than you asked for:

async function* pages(path, limit = 100) {
  for (let offset = 0; ; offset += limit) {
    const res = await fetch(`${path}?limit=${limit}&offset=${offset}`, { headers })
    const { items, page } = await res.json()
    yield* items
    if (page ? !page.hasMore : items.length < limit) return
  }
}