Pagination
List endpoints in the Pixee PIM API return paginated results using page-based pagination. The default page size is 20 items; the maximum is 100.
Page-based pagination
Use the page and per_page query parameters to paginate through results:
Paginated request
curl "https://api.pixeepim.com/api/v1/products?page=1&per_page=20" \
-H "Authorization: Bearer {api_key}"
| Parameter | Type | Default | Max | Description |
|---|---|---|---|---|
page | integer | 1 | — | Page number (1-indexed) |
per_page | integer | 20 | 100 | Number of items to return per page |
Pagination response format
Every list response wraps results in an items array and includes pagination fields directly at the root level:
Paginated response
{
"items": [...],
"total": 1247,
"page": 1,
"per_page": 20,
"pages": 63,
"total_pages": 63
}
| Field | Description |
|---|---|
total | Total items matching the query |
page | Current page number (1-indexed) |
per_page | Items returned per page |
pages | Total number of pages |
total_pages | Alias of pages, kept for consumers that expect this name |
A small number of legacy list endpoints (~19, being migrated) still return the older nested shape { "items": [...], "meta": { "total", "page", "per_page", "total_pages", "has_next", "has_previous" } }. Check the response shape shown on each resource's page — both forms use the same page/per_page query parameters.
Iterating all pages
Page 1 (items 1–20)
curl "https://api.pixeepim.com/api/v1/products?page=1&per_page=20" \
-H "Authorization: Bearer {api_key}"
Page 2 (items 21–40)
curl "https://api.pixeepim.com/api/v1/products?page=2&per_page=20" \
-H "Authorization: Bearer {api_key}"
Continue incrementing page until page exceeds pages.
Legacy aliases (page+page_size, limit+offset, limit+skip) are still honored on
most endpoints for backward compatibility, but are hidden from the public OpenAPI reference
and not recommended for new integrations. Prefer page and per_page.
For large catalogs (100,000+ products), use the Exports feature to bulk-download your data instead of paginating through the API.