Pagination

How list endpoints paginate. Cursors, page sizes, iterating to the end.

List endpoints in vly’s API return at most 20 items by default. Larger result sets paginate via opaque cursors.

The shape

{
  "data": [
    { "id": "prj_...", "name": "..." },
    { "id": "prj_...", "name": "..." }
  ],
  "next_cursor": "eyJpZCI6Ii4uLiJ9"
}

If next_cursor is null, you’ve reached the end.

Iterating

let cursor: string | null = null;
do {
  const page: any = await vly.projects.list({ limit: 100, cursor });
  for (const project of page.data) {
    // ... process
  }
  cursor = page.next_cursor;
} while (cursor);

The SDKs offer an async iterator helper:

for await (const project of vly.projects.iterate({ limit: 100 })) {
  // ... process
}

Limits

Param	Default	Max
limit	20	100

Asking for more than 100 returns 100 with the rest behind cursors.

Related

API introduction

Common patterns overview.

Errors

Error reference.

Rate limits

Limits affect bulk operations.