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

# Retrieve Products

`GET /v1/products`

## Request

- Base URL: `https://api.jasper.ai`
- URL: `https://api.jasper.ai/v1/products`
- Auth: one of:
  - API key in header `X-API-Key`
  - OAuth 2
    - Authorization code: `https://api.jasper.ai/oauth2/authorize`
    - Token URL: `https://api.jasper.ai/oauth2/token` scopes: `user`

Retrieve Products in your workspace.

## Query parameters

- `page` number
- `size` number
- `searchTerm` string

## Response `200`

List of products

- ProductResponseDto
  - `requestId` string, required
  - `resource` string, required
  - `data` ProductData[], required
    - `id` string, required: The unique product ID (`prd_`, or legacy `itm_`).
    - `processingState` 'inProgress' | 'complete' | 'error', required: Processing state of the product.
    - `accessLevel` 'PRIVATE' | 'PUBLIC', required: Who can access the product.
    - `contextSourceIds` string[], required: The IDs of the sources the product itself was generated from, which are managed in the web app and not settable via this API. Empty when none are attached. Expand one with `GET /v1/context-sources/{sourceId}`. This is separate from the sources held by a `CONTEXT_SOURCE_LIST` attribute such as `Images`, which appear under `attributes` and can be set through this API.
    - `attributes` ProductAttributeValueData[], required: The product's attribute values, including the product name (the `Name` attribute). Categories are included here as the `Categories` attribute (an array of category names).
      - `id` string, required: The attribute ID.
      - `name` string, required: The attribute name.
      - `type` 'TEXT_SHORT' | 'TEXT_LONG' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'ENUM' | 'KEY_VALUE' | 'JSON' | 'CONTEXT_SOURCE_LIST', nullable: The attribute's normalized core type (matches the `type` from `GET /products/attributes`), or null when unresolved. List-mode attributes report their core type here and return an array `value`.
      - `isList` boolean, required: Whether the attribute holds a list of values (matches `GET /products/attributes`). When true, `value` is an array.
      - `value` union: The attribute value, typed to match `type`: a string (`TEXT_SHORT`/`TEXT_LONG`/`DATE`, and the option label for `ENUM`), a number (`NUMBER`), a boolean (`BOOLEAN`), an object (`KEY_VALUE`/`JSON`), an array of source IDs (`CONTEXT_SOURCE_LIST`, e.g. `Images` — expand one with `GET /v1/context-sources/{sourceId}`), or — for list-mode attributes — an array of the above (e.g. option labels for a multi-select). Null when the attribute is unset.
        - string
        - number
        - boolean
        - string[]
        - object
        - object[]
    - `createdAt` string, required
    - `updatedAt` string, required
  - `pagination` ProductPaginationDto
    - `totalRecords` number, required: Total number of matching records.
    - `page` number, required: The current page number (1-based).
    - `pageSize` number, required: The number of records per page.
    - `next` object, nullable: URL for the next page, or null on the last page.
    - `prev` object, nullable: URL for the previous page, or null on the first page.

## Other responses

- `400`: Bad request. May be missing required inputs or may have badly formatted inputs.
- `401`: Unauthorized access to the workspace.
- `403`: Product IQ is not enabled for this workspace.
- `500`: Internal server error. Unable to get products.

## Changes

- **2026-11-03** `3d5be7408661`: 1 info
  - endpoint added

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

---

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