Skip to main content

Pagination

All list endpoints (GET /v1/products, GET /v1/suppliers) support pagination.

Query Parameters

ParameterTypeDefaultMaxDescription
pageinteger1Page number (1-indexed)
per_pageinteger50200Results per page
sortstringcreatedAtField to sort by. Prefix with - for descending order
searchstringFull-text search across name, SKU, and other text fields

Sorting

Use the sort parameter to order results. Prefix the field name with - for descending order:

# Sort by name ascending
GET /v1/products?sort=name

# Sort by createdAt descending (newest first)
GET /v1/products?sort=-createdAt

# Sort by SKU ascending
GET /v1/products?sort=sku

The search parameter performs a full-text search across name, model, SKU, GTIN, and other text fields:

GET /v1/products?search=organic+cotton

Response Format

All paginated responses include a pagination object:

{
"products": [ ... ],
"pagination": {
"page": 2,
"perPage": 50,
"total": 243,
"totalPages": 5
}
}
FieldTypeDescription
pageintegerCurrent page number
perPageintegerResults per page for this response
totalintegerTotal number of matching records
totalPagesintegerTotal number of pages

Examples

# Page 2 of products, 25 per page
GET /v1/products?page=2&per_page=25

# Search for "jacket", newest first
GET /v1/products?search=jacket&sort=-createdAt

# All active suppliers, sorted by name
GET /v1/suppliers?sort=name&per_page=200