Skip to main content
GET
List products

Authorizations

x-api-key
string
header
required

Your Store API key (pk_live_...). Create it in Developers › API keys.

x-store-hash
string
header
required

The ID of the store the request is for. Shown in Developers › API keys.

Query Parameters

q
string

Name, slug or exact hash ID.

status
enum<string>
Available options:
draft,
active,
archived
type
enum<string>
Available options:
file,
serial,
subscription,
donation,
contact,
physical
product_kind
enum<string>
Available options:
single,
variants,
donation
active
boolean
category_id
integer
limit
integer
default:25

Items per page (1–100).

Required range: 1 <= x <= 100
offset
integer
default:0

Number of items to skip.

Required range: x >= 0

Response

A page of results

success
boolean
required
Example:

true

products
object[]
pagination
object