TypeScript pagination

List operations return one page and an opaque cursor. Pass the cursor as after to get the next page.

Parameter	Meaning
`limit`	Records per page, 1 to 100. Defaults to 50.
`after`	Opaque cursor from the previous response.
`next_cursor`	Present in the response while more records exist.

Iterate every record

iterateEvents and iterateIssues are async generators that follow the cursor for you and stop when next_cursor is absent.

for await (const issue of client.issues.iterateIssues({
  query: { status: "open", limit: 100 },
})) {
  console.log(issue.id, issue.category, issue.severity, issue.message);
}

for await (const event of client.events.iterateEvents({ query: { limit: 100 } })) {
  console.log(event.id, event.event_type, event.status);
}

The iterators accept the same argument object as the underlying list operation, minus query.after. The iterator owns the cursor, so setting it yourself is a type error.

These iterators walk the whole collection. Break out of the loop, or filter with query.status, when you only need recent records.

Handle one page at a time

Call the list operation directly when you store the cursor between runs, for example in a scheduled job.

let after: string | undefined = await loadCursor();

const page = await client.events.listEvents({
  query: { limit: 100, ...(after ? { after } : {}) },
});

for (const event of page.events) {
  await process(event);
}

if (page.next_cursor) {
  await saveCursor(page.next_cursor);
}

Treat the cursor as opaque. Do not parse it, build it, or assume it stays valid across contract versions.

Issue evidence

listIssueEvents returns the events behind one issue and takes the same pagination parameters.

const evidence = await client.events.listIssueEvents({
  path: { issue_id: "00000000-0000-7000-8000-000000000001" },
  query: { limit: 50 },
});

Notes are not paginated. listIssueNotes returns every note on the issue.

Handle failures in Errors and retries.

Overview

TypeScript

Python

Iterate every record

Handle one page at a time

Issue evidence

Next

​Iterate every record

​Handle one page at a time

​Issue evidence

​Next

Iterate every record

Handle one page at a time

Issue evidence

Next