Pagination
List endpoints (GET /documents, GET /clients, GET /products, GET /recurring-rules, GET /recurring-rules/{id}/history, GET /webhooks/{id}/deliveries, GET /documents/{id}/history, GET /warehouse/movements) are paginated with query parameters:
| Param | Meaning |
|---|---|
currentPage |
1-based page number |
itemsPerPage |
page size; the default and the maximum depend on the list, larger values are capped at the maximum |
searchQuery |
free-text filter (where supported) |
Default and maximum page size:
| List | Default | Maximum |
|---|---|---|
GET /documents, GET /clients, GET /products |
10 | 100 |
GET /recurring-rules |
50 | 100 |
GET /recurring-rules/{id}/history |
50 | 200 |
GET /warehouse/movements |
50 | 100 |
GET /documents/{id}/history |
20 | 100 |
GET /webhooks/{id}/deliveries |
20 | 100 |
The OpenAPI specification also lists the values of each endpoint at its itemsPerPage parameter.
The response includes the page of results plus totalCount and totalPages:
curl -s "https://prod.api.fakturnia.pl/external/v1/documents?currentPage=1&itemsPerPage=50" \
-H "Authorization: Bearer $TOKEN"
{
"success": true,
"data": { "documents": [ /* … */ ], "currentPage": 1, "itemsPerPage": 50, "totalCount": 184, "totalPages": 4, "searchQuery": "" },
"executionTime": 38
}
Iterate by incrementing currentPage until you pass totalPages. Short, bounded lists (GET /warehouse, GET /employees, GET /webhooks, GET /email-accounts) return everything at once. Activity streams (GET /activity, GET /employees/{id}/activity) use a time cursor before / nextBefore, described in History & activity.
Document list filters
GET /documents supports additional filters that can be combined:
| Param | Meaning |
|---|---|
documentType |
document type or a comma-separated list (e.g. FakturaVAT,FakturaKorygujaca) |
dateFrom |
issue date from, inclusive (YYYY-MM-DD) |
dateTo |
issue date to, inclusive (YYYY-MM-DD) |
buyerNip / buyerVatUE / buyerIdentifier |
documents for a buyer with the given identifier |
excludeIds |
comma-separated list of document IDs to skip |
onlyUnlinked |
only documents without an order reference |
curl -s "https://prod.api.fakturnia.pl/external/v1/documents?documentType=FakturaVAT&dateFrom=2026-01-01&dateTo=2026-01-31" \
-H "Authorization: Bearer $TOKEN"
An unknown documentType or a badly formatted date returns 400 with the INVALID_PARAMS code. The accepted types are listed in the dictionaries.
Lists are subject to rate limits — page through results sequentially and cache them rather than polling aggressively.