Skip to main content
GET
/
v1
/
products
List
curl --request GET \
  --url https://{defaultHost}/v1/products \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/products"
  },
  "data": [
    {
      "id": "008893e2-2c7d-4d21-97d2-fe8881a82511",
      "object": "product",
      "allow_out_of_stock_purchases": false,
      "archived": false,
      "archived_at": null,
      "auto_fulfill_enabled": false,
      "available_stock": 0,
      "average_stars": "0.0",
      "description": null,
      "held_stock": 0,
      "featured": false,
      "licensing_enabled": false,
      "license_activation_limit": null,
      "metadata": {},
      "purchase_limit": null,
      "metrics": {
        "currency": "usd",
        "max_price_amount": 2900,
        "min_price_amount": 2900,
        "prices_count": 1
      },
      "name": "Test Product",
      "recurring": true,
      "reviews_breakdown": {},
      "reviews_enabled": true,
      "shipping_enabled": false,
      "sku": null,
      "slug": "test-product",
      "solicit_reviews": true,
      "status": "draft",
      "stock": 0,
      "stock_enabled": false,
      "tax_enabled": false,
      "tax_category": "tangible",
      "weight": 0,
      "weight_unit": "lb",
      "commission_structure": null,
      "featured_product_media": null,
      "product_group": null,
      "current_release_download": null,
      "shipping_profile": null,
      "cataloged_at": 1767909737,
      "discarded_at": null,
      "created_at": 1767909738,
      "updated_at": 1767909738
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
ad_hoc
boolean

Only return prices that allow ad hoc amounts or not.

​
archived
boolean

Only return objects that are archived or not archived.

​
downloadable
boolean

Only return objects that have associated downloads.

​
featured
boolean

Only return products that are featured or not.

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
page
integer

The page of items you want returned.

​
product_collection_ids[]
string[]

Only return objects that belong to the given product collections.

​
product_group_ids[]
string[]

Only return objects that belong to the given product groups.

​
query
string

The query to be used for full text search of this collection.

​
recurring
boolean

Only return products that are recurring or not recurring (one time).

​
shipping_enabled
boolean

Only return objects that have shipping enabled or disabled.

​
shipping_profile_ids[]
string[]

Only return objects that belong to the given shipping profile.

​
status[]
string[]

Only return objects with the given status.

​
sort
string

The sorting column and order to be used for this collection. Available sorting columns for this endpoint are cataloged_at, created_at, name, and updated_at.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.