Documentation

Copy page

Pagination & Filtering

All list endpoints in the Strictly API support pagination and filtering via query parameters. Understanding these parameters helps you avoid timeouts, retrieve complete datasets, and build efficient integrations.

---

Default behavior

If you omit pagination parameters, the API returns the first 10 records, sorted by -updatedAt (most recently updated first). For most production use cases you will want to control this explicitly.

---

Response envelope

Paginated endpoints return a meta block next to data:

Code
{
  "meta": {
    "count": 137,
    "totalPages": 14,
    "page": 1,
    "limit": 10
  },
  "data": [
    { "id": "670fbdf6fce1362341bcaf9f", "firstName": "Jane", "lastName": "Smith" },
    { "id": "670fbdf6fce1362341bcafa0", "firstName": "John", "lastName": "Doe" }
  ]
}

Field	Description
meta.count	Total number of records matching the filters (not the page size)
meta.totalPages	ceil(count / limit)
meta.page, meta.limit	Echo of the request — strings when supplied as query params, numbers (1, 10) when defaulted

---

Pagination parameters

Parameter	Type	Default	Description
page	integer	1	Page number (1-based)
limit	integer	10	Number of records per page. limit=0 on /public/customer returns all records
keyword	string	—	/public/customer only: partial match on name, email, phone, company, external id and card last 4

Get first 50 records
curl "https://api.paywithzero.net/v1/public/plan?limit=50" \
  -H "Authorization: Basic $(echo -n '[email protected]:yourpassword' | base64)" \
  -H "key-hash: YOUR_KEY_HASH"

Get page 2 (records 11–20 at default limit)
curl "https://api.paywithzero.net/v1/public/plan?page=2" \
  -H "Authorization: Basic $(echo -n '[email protected]:yourpassword' | base64)" \
  -H "key-hash: YOUR_KEY_HASH"

Get page 3 with 25 records per page
curl "https://api.paywithzero.net/v1/public/plan?page=3&limit=25" \
  -H "Authorization: Basic $(echo -n '[email protected]:yourpassword' | base64)" \
  -H "key-hash: YOUR_KEY_HASH"

---

Sorting

Use the sort parameter to control result order. The default is -updatedAt. Prefix the field name with - for descending order (most recent first):

Example	Result
sort=transactions.transactionAt	Ascending (oldest first)
sort=-transactions.transactionAt	Descending (newest first)

Most recent transactions first
curl "https://api.paywithzero.net/v1/public/transactions?sort=-transactions.transactionAt" \
  -H "Authorization: Basic $(echo -n '[email protected]:yourpassword' | base64)" \
  -H "key-hash: YOUR_KEY_HASH"

---

Date range filtering

Many endpoints accept startDay and endDay to filter records by a time window. Both are truncated to whole days — the time component is ignored.

Format

Both parameters accept ISO 8601 (YYYY-MM-DDTHH:mm:ss.SSSZ) or a plain date (YYYY-MM-DD); only the day is used.

Example	Represents
2025-03-03T05:00:00.000Z	March 3, 2025 at 5:00 AM UTC
2025-03-06T04:59:59.999Z	March 6, 2025 at 4:59:59.999 AM UTC

---

Timezone parameter

The timezone parameter adjusts day-boundary filtering to a named timezone so you don't have to manually calculate UTC offsets. It is honored by report endpoints only (default America/New_York) and ignored by /public/transactions:

Code
curl "https://api.paywithzero.net/v1/public/report/pivotReport?startDay=2025-03-03&endDay=2025-03-06&timezone=America/Chicago" \
  -H "Authorization: Basic $(echo -n '[email protected]:yourpassword' | base64)" \
  -H "key-hash: YOUR_KEY_HASH"

Accepted values follow the IANA timezone database, for example:

• America/New_York
• America/Chicago
• America/Los_Angeles
• America/Denver
• UTC

---

Full example

This request retrieves the 10 most recent transactions within a 3-day window, sorted by date:

cURL
curl "https://api.paywithzero.net/v1/public/transactions\
?page=1\
&limit=10\
&sort=-transactions.transactionAt\
&startDay=2025-03-03T05:00:00.000Z\
&endDay=2025-03-06T04:59:59.999Z" \
  -H "Authorization: Basic $(echo -n '[email protected]:yourpassword' | base64)" \
  -H "key-hash: YOUR_KEY_HASH"

JavaScript
const params = new URLSearchParams({
  page: "1",
  limit: "10",
  sort: "-transactions.transactionAt",
  startDay: "2025-03-03T05:00:00.000Z",
  endDay: "2025-03-06T04:59:59.999Z",
});

const response = await fetch(
  `https://api.paywithzero.net/v1/public/transactions?${params}`,
  {
    headers: {
      Authorization: `Basic ${btoa("[email protected]:yourpassword")}`,
      "key-hash": "YOUR_KEY_HASH",
    },
  }
);

const { meta, data } = await response.json();

console.log(`Showing ${data.length} of ${meta.count} transactions (page ${meta.page}/${meta.totalPages})`);

---

Best practices

• Always set page and limit explicitly to prevent silent data truncation at 10 records
• Sort by date descending (sort=-transactions.transactionAt) to get recent records first when building dashboards or activity feeds
• Use meta.count / meta.totalPages to drive pagination instead of guessing from data.length
• Use timezone on report endpoints instead of manually converting UTC offsets
• Page through all results in batch jobs rather than raising limit to extreme values, which can cause timeouts on large datasets

---

Which endpoints support pagination?

Pagination (page, limit, sort) is supported on all list (GET) endpoints, including:

• GET /public/customer
• GET /public/transactions
• GET /public/plan
• GET /public/subscription
• GET /public/invoice
• GET /public/ach
• GET /public/202104/payment-link

Report endpoints such as GET /public/report/pivotReport are not paginated: they return the full result for the requested date range.

Date range filtering (startDay, endDay) is supported on transactions, reports, customers, ACH payments, invoices and payment requests; timezone only on report endpoints. See the API Reference for the full parameter list per endpoint.