Pagination

{
  "data": [],
  "has_more": true,
  "next_cursor": "cmexample",
  "limit": 100
}

curl "$PERKSTAR_API_URL/customers?limit=100&cursor=cmexample" \
  --header "Authorization: Bearer $PERKSTAR_API_KEY"

​

Rules

• Treat cursors as opaque strings. Do not parse or increment them.
• Stop when has_more is false or next_cursor is null.
• Keep the same filters while following a cursor.
• Process each page before requesting the next one to avoid memory spikes.
• Checkpoint the last completed cursor in long-running backfills.
• Make your destination writes idempotent because records can change during a scan.

​

TypeScript SDK

for await (const customer of perkstar.customers.list({ limit: 100 })) {
  await upsertCustomer(customer);
}