Developer docsPagination
Basics

Pagination

Lists come newest first, up to 100 at a time. How to find what you need until cursors arrive.

Updated View as Markdown

Two endpoints return long lists: List conversations and Search documents. Both:

  • return a plain JSON array, newest first;
  • take limit, from 1 to 100. Leave it out and you get 25.

The inbox and tag lists (List mailboxes and List tags) always return everything.

Getting past the first 100

There's no cursor yet. To reach what you need, narrow the list instead of paging through it:

  • view picks open, waiting, snoozed or closed conversations. Most work lives in open.
  • mailbox keeps to one inbox. Get the ids from List mailboxes.
  • q searches the text of every message, so a name, an order number or an address finds the thread.
  • assigned=me shows what's assigned to your key's agent, and assigned=unassigned what nobody has.
  • For documents, kind picks invoices, receipts, contracts and so on, and q searches titles and what Fetch read.

What's coming

Cursor pagination will be added without changing what you get today: a new, optional parameter that continues from the last item you saw. Calls you write now will keep working. Watch the changelog.