Pagination & filtering

List endpoints don't all paginate the same way. The Fungies API ships three conventions, and which one an endpoint uses depends on the resource. Check this page before you write a paging loop.

1. Offset pagination — skip / take

The most common convention. Pass skip (how many records to step over) and take (page size).

curl "https://api.fungies.io/v0/orders/list?skip=0&take=20&returnCount=true" \
  -H "x-fngs-public-key: pub_your_public_key"

{
  "status": "success",
  "data": {
    "orders": [{ "object": "order", "id": "550e8400-e29b-41d4-a716-446655440000" }],
    "count": 143
  }
}

take has a default and a cap

On orders, payments, products, and offers, take defaults to 20 and is capped at 100. GET /v0/elements/checkout/list and GET /v0/webhooks/{webhookId}/attempts default to 10, also capped at 100.

Asking for more than the cap is not an error: take=500 returns the first 100 records with a 200. Because the response looks like any other full page, a loop that assumes it received 500 rows will skip the ones in between — step skip by the number of records you actually got back, not by the number you asked for. A take below 1 is raised to 1.

count is opt-in

GET /v0/elements/checkout/list and GET /v0/webhooks/{webhookId}/attempts don't take returnCount — they always return a count.

Without a count, page until a response comes back with fewer records than you asked for:

const take = 100;
let skip = 0;

for (;;) {
  const url = `https://api.fungies.io/v0/orders/list?skip=${skip}&take=${take}`;
  const { data } = await get(url);

  yield* data.orders;

  if (data.orders.length < take) break;
  skip += take;
}

2. Page pagination — page / limit

Used by the user endpoints. page is 1-based, and the count is always returned, together with the total number of pages.

curl "https://api.fungies.io/v0/users/list?page=1&limit=25" \
  -H "x-fngs-public-key: pub_your_public_key"

{
  "status": "success",
  "data": {
    "users": [{ "object": "user", "id": "550e8400-e29b-41d4-a716-446655440000" }],
    "count": 143,
    "pages": 6
  }
}

Stop when page reaches pages.

3. Cursor pagination — cursor / take

Only GET /v0/subscriptions/list. Pass take (1–100, default 10) and, from the second page on, the cursor returned by the previous response.

{
  "status": "success",
  "data": {
    "subscriptions": [{ "object": "subscription", "id": "550e8400-e29b-41d4-a716-446655440000" }],
    "count": 10,
    "cursor": "c3Vic2NyaXB0aW9uXzEyMw",
    "hasMore": true
  }
}

Loop on hasMore, not on count — count is a total where one is available, and it can be null.

let cursor;

for (;;) {
  const query = new URLSearchParams({ take: "50", ...(cursor ? { cursor } : {}) });
  const { data } = await get(`https://api.fungies.io/v0/subscriptions/list?${query}`);

  yield* data.subscriptions;

  if (!data.hasMore || !data.cursor) break;
  cursor = data.cursor;
}

Sorting

Most offset-paginated endpoints accept orderDirection:

• ASC — ascending (oldest or lowest first)
• DESC — descending (newest or highest first)

The resource lists also accept orderBy to choose the field. Accepted values differ per resource, and a few endpoints (such as GET /v0/elements/checkout/list) have a fixed order and take neither parameter — check the endpoint's reference page.

Archived records

Archiving is a soft delete — the record stays readable but drops out of normal listings. Two independent flags give you three behaviours:

This is also why a GET by id can return 404 right after you archive something: the record still exists, but the default read excludes it.

Filtering

Filters are per-resource query parameters — status, currency, country, date windows, custom fields, and more. They combine with AND. See each endpoint's reference page for the full list.

Two things catch people out on order, payment, and subscription filters:

• Numbers are matched verbatim. The dashboard shows a leading #; it is not part of the stored value. Send L8VQK3N2M7KpQ9nR, not #L8VQK3N2M7KpQ9nR, or the filter returns no rows.
• Money is in the smallest currency unit. valueFrom=1000 means 10.00 USD, and ¥1000 in JPY.