---
title: "List products"
method: GET
path: "/object-query/products"
tags: ["Object Queries"]
---

# List products

`GET /object-query/products`

Lists Product objects. You can use the query parameters to filter, expand, and sort the returned results.

## Query parameters

- `pageSize` integer
- `cursor` string
- `sort[]` string[]
- `expand[]` string[]
- `filter[]` string[]
- `fields[]` string[]
- `includeNullFields` boolean

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Response `200`

OK

- object
  - `nextPage` string, nullable — A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.
  - `data` ExpandedProduct[]
    - `id` string — The unique identifier of the product.
    - `createdById` string — The unique identifier of the user who created the product.
    - `createdDate` string, date-time — The date and time when the product was created.
    - `updatedById` string — The unique identifier of the user who last updated the product.
    - `updatedDate` string, date-time — The date and time when the product was last updated.
    - `allowFeatureChanges` boolean — Controls whether to allow your users to add or remove features while creating or amending a subscription.
    - `description` string — A description of the product.
    - `name` string — The name of the product. This information is displayed in the product catalog pages in the web-based UI.
    - `effectiveEndDate` string, date — The date when the product expires and can't be subscribed to anymore, in the `yyyy-mm-dd` format.
    - `effectiveStartDate` string, date — The date when the product becomes available and can be subscribed to, in the `yyyy-mm-dd` format.
    - `sKU` string — The unique SKU for the product.
    - `productNumber` string — The product number of the product.
    - `category` 'Base Products' | 'Add On Services' | 'Miscellaneous Products' — Category of the product. Used by Zuora Quotes Guided Product Selector.
    - `productRatePlans` NestedProductRatePlanOnExpand[]
      - `id` string — The unique identifier of the product rate plan.
      - `createdById` string — The unique identifier of the user who created the product rate plan.
      - `createdDate` string, date-time — The date and time when the product rate plan was created.
      - `updatedById` string — The unique identifier of the user who last updated the product rate plan.
      - `updatedDate` string, date-time — The date and time when the product rate plan was last updated.
      - `productId` string — The unique identifier of the product to which this product rate plan belongs.
      - `name` string — The name of the product rate plan.
      - `description` string — A description of the product rate plan.
      - `effectiveStartDate` string, date — First date the rate plan is active (i.e., available to be subscribed to), as `yyyy-mm-dd`. Before this date, the status is `NotStarted`.
      - `effectiveEndDate` string, date — Final date the rate plan is active, as `yyyy-mm-dd`. After this date, the rate plan status is `Expired`.
      - `grade` integer — The grade of the product rate plan. **Note**: This field is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).
      - `productRatePlanNumber` string — The natural key of the product rate plan.
      - `product` object — The product associated with the product rate plan.
      - `productRatePlanCharges` object[] — The product rate plan charges on the product rate plan.

## Other responses

- `500` — Internal server error
- `4XX` — Invalid input

---

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