Skip to main content
GET
Products

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your API token.

Query Parameters

collection
string

Filter products by collection slug or name. Products will be ordered by their position in the collection.

attr
object

Filter products by attributes using deep object notation. Each attribute filter accepts comma-separated values for OR matching.

Format: attr[attribute_slug]=value1,value2

Example: attr[color]=red,blue&attr[size]=large This returns products that are (red OR blue) AND large.

sort
string

Sort products by field and direction. Format: field.direction (e.g., price.asc, name.desc). Multiple sort options can be comma-separated.

limit
integer

Limit the number of results returned. Maximum 50 per page.

Required range: 1 <= x <= 50
page
integer

Page number for pagination.

Required range: x >= 1
perPage
integer
default:50

Number of items per page. Default is 50.

Required range: 1 <= x <= 50
include
enum<string>

Comma-separated list of related resources to include in the response.

Available options: linkedSubscriptions (includes full subscription details for products with linked subscriptions).

Available options:
linkedSubscriptions

Response

200 - application/json

products

data
object[]
meta
object