Pagination

Lists that can grow long come back one page at a time. You choose the page with two query parameters, and the response tells you how many results there are in total.

Page parametersCopy Anchor Link

Both are optional. A limit outside the allowed range is refused with a 400. An offset past the end returns an empty page.

curl "https://api.lahuta.org/v1/events?limit=10&offset=10" \
  -H "X-Api-Key: $LAHUTA_API_KEY"

The page envelopeCopy Anchor Link

A paginated response wraps the results with the numbers you need to build "previous" and "next" links:

{
  "items": [{ "shortCode": "k7Qm2x", "name": "Intro to the wheel" }],
  "total": 14,
  "limit": 10,
  "offset": 10
}

• items is this page's results.
• total is how many results there are across all pages.
• limit and offset echo what the server used, defaults included.

There's a next page while offset + limit is less than total.

Which endpoints are paginatedCopy Anchor Link

Group rows allow bigger pages because a site usually shows a whole group at once, like a team directory. See Contacts and groups.

Endpoints that return everythingCopy Anchor Link

These return the full list in one response, with no page parameters:

Fetch every pageCopy Anchor Link

Most sites only need the first page. If you do need everything, for example to build a static archive of your blog, loop until you've read total results:

async function allPosts() {
  const posts = []
  let offset = 0
  while (true) {
    const res = await fetch(
      `https://api.lahuta.org/v1/blog/posts?limit=100&offset=${offset}`,
      { headers: { "X-Api-Key": process.env.LAHUTA_API_KEY } }
    )
    const page = await res.json()
    posts.push(...page.items)
    offset += page.limit
    if (offset >= page.total) return posts
  }
}

New posts or events can appear between two requests, so a result may shift by one position across pages. For a public listing that's rarely noticeable. If it matters, fetch the whole list at once with a larger limit.

RelatedCopy Anchor Link