---
title: "Retrieve a paginated list of products"
method: GET
path: "/v2/products"
tags: ["Products"]
---

# Retrieve a paginated list of products

`GET /v2/products`

Retrieves the paginated list of products, optionally filtered by customer key, stack key, or click xid.

## Query parameters

- `customer_key` string
- `stack_key` string
- `click_xid` string
- `order_by` '-created_at' | 'created_at' | '-updated_at' | 'updated_at'
- `limit` integer
- `starting_after` string
- `ending_before` string

## Response `200`

Retrieves the paginated list of products, optionally filtered by customer key, stack key, or click xid.

- object
  - `data` object, required
    - `has_more` boolean
    - `items` object[]
      - `created_at` integer — Immutable Unix timestamp in milliseconds taken at time of creation
      - `key` string — A unique identifier used to reference the object
      - `updated_at` integer — Unix timestamp in milliseconds taken at time of last update
      - `amount` integer, nullable — The amount/value of the product instance in cents
      - `click_xid` string, nullable — The click xID associated with this product
      - `company_id` integer — The ID of the company that owns this product
      - `currency` string, nullable — ISO 4217 currency code (e.g. USD, EUR)
      - `customer_key` string — The key of the customer that owns this product
      - `external_subscription_key` string, nullable — The external subscription key (e.g., from billing system)
      - `field_data` object — Data for the custom properties of the product
      - `member_email` string, nullable — Email of the team member associated with this product
      - `member_logo` string, nullable — Profile image URL of the team member associated with this product
      - `member_name` string, nullable — Display name of the team member associated with this product
      - `metadata` object — Vendor-defined product metadata
      - `name` string, nullable — The name of the product from the Product Book
      - `partner_logo` string, nullable — Team logo of the partner associated with this product
      - `partner_name` string, nullable — Team name of the partner associated with this product
      - `partnership_key` string, nullable — The Partnership key of the partnership that this product instance is associated with
      - `product_book_key` string — The key of the product book that defines this product
      - `stack_key` string, nullable — The Stack key of the Partner Team member stack that this product instance is associated with
      - `status` string — The status of the product
      - `team_color` string, nullable — Team color of the partner associated with this product
    - `total` integer, nullable
  - `message` string, required
  - `status` integer, required

## Other responses

- `400` — Bad Request Error
- `401` — Unauthorized Error
- `403` — Forbidden Error
- `404` — Not Found Error
- `500` — Internal Server Error

---

[API](https://skmtc.dev/partnerstack/apis/partnerstack-api.md) · [All operations](https://skmtc.dev/partnerstack/apis/partnerstack-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/partnerstack/partnerstack-api/revisions/0f35aebe53a9/schema)