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

# List products

`GET /v1/products`

Retrieve existing products.

## Query parameters

- `take` number, nullable
- `skip` number, nullable
- `id` string
- `id__not` string
- `id__isNull` string
- `id__isNotNull` string
- `id__equals` string
- `id__contains` string
- `id__startsWith` string
- `id__endWith` string
- `status` union
  - 'all' | 'active' | 'archived'
  - string — all,active
- `status__in` union
  - 'all' | 'active' | 'archived'
  - string — all,active
- `name` string
- `name__not` string
- `name__isNull` string
- `name__isNotNull` string
- `name__equals` string
- `name__contains` string
- `name__startsWith` string
- `name__endWith` string
- `description` string
- `description__not` string
- `description__isNull` string
- `description__isNotNull` string
- `description__equals` string
- `description__contains` string
- `description__startsWith` string
- `description__endWith` string
- `type` string
- `type__not` string
- `type__isNull` string
- `type__isNotNull` string
- `type__equals` string
- `type__contains` string
- `type__startsWith` string
- `type__endWith` string
- `price_book_id` string

## Response `200`

- PaginatedProduct
  - `meta` object, required
    - `total` number, required — Total of existing items.
    - `taken` number, required — Number of items returned.
    - `skipped` number, required — Number of items skipped.
  - `data` ProductSimple[], required — List of Product. — unresolved $ref

---

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