List products

Retrieves a paginated list of all products in the catalog.

Query Parameters

ParameterTypeRequiredDescription
pageintegerNoPage number for pagination (default: 1)
limitintegerNoNumber of items per page (default: 50)
orderstringNoField to sort by (default: id)
directionstringNoSort direction: asc or desc (default: desc)
archivedbooleanNoFilter by archived status

Filtering

This endpoint supports advanced filtering. See the Filter System Documentation for the complete list of operators and usage examples.

Quick examples:

?filters[name][contains]=lamp
?filters[active][eq]=true
?filters[tax.rate][gte]=0.1
?filters[customFields.category][eq]=electronics

Response Fields

FieldTypeDescription
idintegerProduct unique identifier
namestringProduct name
referencestringProduct reference/SKU
descriptionstringProduct description
activebooleanWhether product is active
archivedbooleanWhether product is archived
urlstringExternal URL (e.g., supplier link)
tipsstringAdditional tips or notes
customFieldsobjectCustom field values
unityobjectUnit of measure
mediasarrayAssociated media files
pricesarrayProduct prices by category
createdAtdatetimeCreation timestamp
updatedAtdatetimeLast update timestamp

Response

  • 200 OK: Returns paginated list of products
  • 401 Unauthorized: Invalid or missing API key
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
integer
string
string
boolean
Responses
200

Successful response

401

Unauthorized

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!