---
title: "List products"
method: GET
path: "/products"
tags: ["Products"]
---

# List products

`GET /products`

## Request

- Base URL: `https://api.privy.com/v1`
- URL: `https://api.privy.com/v1/products`
- Auth: HTTP bearer

Retrieve the product catalog of your connected store (Shopify or BigCommerce), proxied live from the store's API.

Unlike the other list endpoints, products use **cursor pagination**:
pass the `next_cursor` from each response as `?cursor=` to fetch the next page,
keeping the same filters. There are no `page` numbers.

Requires a connected Shopify or BigCommerce store — without one, this endpoint returns `404 no_connected_store`.

The response shape is the same on both platforms; fields BigCommerce does not
supply (`product_type`, `vendor`, `url`) are `null`. Large `per_page` values can
be slow on BigCommerce stores whose products carry many variants — reduce
`per_page` if requests return `502 store_unavailable`.

A live read of the store's own catalog — nothing here is Privy data, and no
endpoint reports sales or performance per product. `/v1/products/{id}` adds
description, tags, options, and images.

**Required scope:** `products_read`

## Query parameters

- `per_page` integer
- `title` string
- `handle` string
- `cursor` string

## Headers

- `Privy-Account-Id` string

## Response `200`

A page of the store's product catalog.

- object
  - `data` Product[]
    - `id` integer: The store's product id. Use this value in `/v1/products/{id}`. Matches the product ids on order line items.
    - `title` string
    - `handle` string, nullable: The product's URL slug. `null` on BigCommerce products with no storefront path.
    - `status` 'active' | 'draft' | 'archived'
    - `product_type` string, nullable: The merchant-defined product category. Always `null` on BigCommerce stores.
    - `vendor` string, nullable: The product's vendor/brand. Always `null` on BigCommerce stores.
    - `url` string, nullable: The product's storefront URL. `null` if not published to the online store; always `null` on BigCommerce stores.
    - `image_url` string, nullable
    - `price_range` object, nullable
      - `min` string
      - `max` string
      - `currency_code` string
    - `total_inventory` integer, nullable: Total sellable inventory across variants. `null` when the store does not report it.
    - `tracks_inventory` boolean
    - `variants_count` integer, nullable: Total number of variants on the product (the `variants` array may be truncated below this).
    - `variants` ProductVariant[]
      - `id` integer: The store's variant id.
      - `title` string, nullable: `null` on BigCommerce stores for a product's base variant (it has no option values); Shopify default variants carry "Default Title" instead.
      - `price` string, nullable: Variant price in the store's currency, as a decimal string.
      - `compare_at_price` string, nullable
      - `sku` string, nullable
      - `inventory_quantity` integer, nullable
      - `available` boolean: Whether the variant can currently be purchased (untracked inventory counts as available).
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `pagination` CursorPagination: Cursor-based pagination envelope, used by the Products and Product Collections endpoints.
    - `per_page` integer
    - `total_count` integer, nullable: Total items across every page. `null` when the store does not report one.
    - `has_more` boolean
    - `next_cursor` string, nullable: Opaque cursor for the next page. Pass as `?cursor=`. `null` on the last page.

## Other responses

- `401`: Missing or invalid bearer token.
- `403`: `insufficient_scope` when the token lacks the required scope for this endpoint.
- `404`: The account has no connected store, so there is no catalog to read.
- `422`: One or more fields failed validation.
- `429`: Rate limit exceeded — either Privy's API rate limit (code `rate_limited`, with the `X-RateLimit-*` headers) or the connected store's own quota passed through (code `store_rate_limited`). `Retry-After` carries the wait when it is known — BigCommerce's reset window, or a wait derived from Shopify's throttle cost payload.
- `502`: The connected store's API could not be reached or returned an error. Retry shortly.

## Changes

- **2026-11-05** `cf0885e90d5a`: 12 warning
  - added the new `forbidden` enum value to the `error/code` response property for the response status `401`
  - added the new `forbidden` enum value to the `error/code` response property for the response status `403`
  - added the new `forbidden` enum value to the `error/code` response property for the response status `404`
  - added the new `forbidden` enum value to the `error/code` response property for the response status `422`
  - …8 more
- **2026-11-03** `fe500ab59b3b`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/privy/apis/privy-api/changes/products/get.md)

---

[API](https://skmtc.dev/privy/apis/privy-api.md) - [All operations](https://skmtc.dev/privy/apis/privy-api/llms.txt) - [OpenAPI document](https://skmtc.dev/privy/apis/privy-api/revisions/bc29b48dcdd2?raw)