Pagination

Lists that can grow long (customers, quotes, invoices, payments, orders, the event log and others) come back one page at a time.

Limit and offsetCopy Anchor Link

Send limit (how many to return) and offset (how many to skip) in the query string:

curl "https://app.skuflow.ai/api/organizations/$ORGANIZATION_ID/invoices?limit=100&offset=200" \
  -H "Authorization: Bearer $SKUFLOW_API_KEY"

The answer is an object with the page's items and the total number of matches across every page:

{
	"items": [{ "id": "…", "identifier": "INV-201" }],
	"total": 1342
}

• limit is 50 when you leave it out. Most lists allow up to 200; each list's maximum is in the API reference.
• offset starts at 0.
• Keep going while offset + items.length < total.
• Filters (status, query, dates …) apply before paging, so total counts only what matches.

async function allInvoices(organizationId) {
	const all = [];
	for (let offset = 0; ; offset += 200) {
		const response = await fetch(
			`https://app.skuflow.ai/api/organizations/${organizationId}/invoices?limit=200&offset=${offset}`,
			{ headers: { Authorization: `Bearer ${process.env.SKUFLOW_API_KEY}` } },
		);
		const page = await response.json();
		all.push(...page.items);
		if (offset + page.items.length >= page.total || page.items.length === 0) return all;
	}
}

CursorsCopy Anchor Link

A few feeds that only grow use a cursor instead: a customer's timeline and the website and email image libraries. Pass the nextCursor from one answer as cursor in the next call. When nextCursor is null, you have everything. Team chat takes before, the time of the oldest message you have.

Short listsCopy Anchor Link

Settings-style lists that stay small (lead sources, custom fields, business units, webhook endpoints) come back whole, as an array or an object without total. The reference shows which shape each endpoint returns.

RelatedCopy Anchor Link

• Conventions
• Rate limits