# List products

```http
GET https://secure.yoprint.com/v1/api/store/{team_slug}/product
```

- API version: v1
- Operation ID: `v1_public_products_index`
- Section: Products and catalog › [Products](https://developer.yoprint.com/reference/products.md)
- Web page: https://developer.yoprint.com/reference/products/v1-products-index/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Lists your own products (simple and variant products), paged. Supplier catalog products are not in this list.

Every live product by default, or with `status` one sale state or the deleted products (newest delete first). Each row adds `variant_count`, `phased_out_variant_count` and `deleted_variant_count` (variant products; null for simple products), `deleted_at`, and `phased_out_by` and `deleted_by` as `{id, name}` or null.

The list is paged: `pagination` gives `total`, `count`, `perPage`, `currentPage` and `totalPages`. Ask for the next page with `page`; the page size is the team's setting (50 unless changed), and `per_page` is ignored.

## Permission

Any member of the team.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Query parameters

- `status` (string, optional): Filters the list by sale state. Leave absent for every live product. - `on_sale`: simple products on sale, and variant products with at least one live size or color on sale. - `phased_out`: simple products phased out, and variant products with at least one live size or color phased out. A partly phased-out variant product appears in both `on_sale` and `phased_out`. - `deleted`: deleted products only, newest delete first. A variant product with no live sizes or colors left is in neither `on_sale` nor `phased_out`. Any other value returns 422. One of: `"on_sale"`, `"phased_out"`, `"deleted"`. Example `phased_out`.
- `page` (integer, optional): The page to return. Pages hold the team's page size (`pagination_per_page` in team settings: 50 unless changed, 5 to 100). `per_page` is not read here. Default `1`. Minimum 1. Example `1`.

## Request body

This operation takes no request body.

### Example request

```bash
curl 'https://secure.yoprint.com/v1/api/store/your-team/product' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (array of objects, required)
  - Each item:
    - `deleted_at` (string (date-time) | null, required)
    - `deleted_by` (object | null, required): Who deleted the product; null while live, or when nobody was recorded.
      - `id` (string, required)
      - `name` (string, required)
    - `deleted_variant_count` (integer | null, required): Variant products: sizes and colors deleted on their own, not with the product, which a restore leaves deleted; one per size and color combination, and none for a combination that is live again (added back after its delete). Null for simple products.
    - `id` (string, required)
    - `phased_out_by` (object | null, required): Who phased out a simple product; null while on sale, for variant products, or when nobody was recorded. A deleted user keeps their name.
      - `id` (string, required)
      - `name` (string, required)
    - `phased_out_variant_count` (integer | null, required): Variant products: how many of `variant_count` are phased out. Null for simple products.
    - `title` (string, required)
    - `trashed` (boolean, required)
    - `type` (string, required): One of: `"simple"`, `"variant"`.
    - `variant_count` (integer | null, required): Variant products: their live sizes and colors; for a deleted product, the ones its restore brings back. Null for simple products.
    - `barcode` (string | null, optional): Simple products only.
    - `brand` (string | null, optional)
    - `color_data` (array of objects, optional): A variant product's colors; `[]` for simple products.
      - Each item:
        - `id` (string, required)
        - `label` (string | null, required)
        - `hex` (string | null, optional)
    - `default_price` (integer | number | string | null, optional): The selling price of a simple product. Variant products price each size and color instead (List a product's variants). Null when not set. Thousandths, an older encoding: `12500` is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (`1234.5` is 1.2345), or as a string (`"1234.5"`) when you send `X-Yoprint-Decimal-Format: exact-v1`. See [Money and quantities](/concepts/money-and-quantities/).
    - `description` (string | null, optional)
    - `enable` (boolean, optional)
    - `phased_out` (boolean, optional): Simple products only. Variant products phase out their sizes and colors.
    - `phased_out_at` (string (date-time) | null, optional): Simple products only.
    - `price_data` (object | array, optional): Simple products only. Prices for pricing groups, as saved: keyed by the pricing group's internal number (not its hash id), each `{"price": <thousandths>}`. An empty list `[]` when there are none.
    - `size_data` (array of objects, optional): A variant product's sizes; `[]` for simple products.
      - Each item:
        - `id` (string, required)
        - `label` (string | null, required)
    - `supplier_id` (string | null, optional)
    - `taxable` (boolean, optional)
    - `track_inventory` (boolean, optional): Simple products only.
    - `variant_type` (string, optional): Variant products only. One of: `"size"`, `"color"`, `"size_color"`.
    - `vendor_id` (string | null, optional): The vendor's id, or null.
    - `weight` (number | string | null, optional): Simple products only.
- `status` (integer, required)
- `success` (boolean, required)
- `pagination` (object, optional)
  - `count` (integer, required)
  - `currentPage` (integer, required)
  - `links` (object | array of any, required): Links to the neighbouring pages: `previous` and `next`, each present only when that page exists. An empty list, `[]`, when there is only one page.
    - `next` (string (uri), optional): The next page.
    - `previous` (string (uri), optional): The previous page.
  - `perPage` (integer, required)
  - `total` (integer, required)
  - `totalPages` (integer, required)

Example response:

```json
{
  "data": [
    {
      "barcode": null,
      "brand": "Northwind",
      "color_data": [],
      "default_price": 12500,
      "deleted_at": null,
      "deleted_by": null,
      "deleted_variant_count": null,
      "description": null,
      "enable": true,
      "id": "zSSqymW2yER9jw",
      "phased_out": true,
      "phased_out_at": "2026-11-01T02:00:00+00:00",
      "phased_out_by": {
        "id": "lOURnovd3hkIQI",
        "name": "Alex Rivera"
      },
      "phased_out_variant_count": null,
      "price_data": [],
      "size_data": [],
      "supplier_id": "MUG-11",
      "taxable": true,
      "title": "Enamel mug",
      "track_inventory": true,
      "trashed": false,
      "type": "simple",
      "variant_count": null,
      "vendor_id": null,
      "weight": null
    },
    {
      "brand": "Northwind",
      "color_data": [],
      "default_price": null,
      "deleted_at": null,
      "deleted_by": null,
      "deleted_variant_count": 0,
      "description": null,
      "enable": true,
      "id": "Xe3wCbaZYrxJAI",
      "phased_out_by": null,
      "phased_out_variant_count": 1,
      "size_data": [
        {
          "id": "S",
          "label": "S"
        },
        {
          "id": "M",
          "label": "M"
        },
        {
          "id": "L",
          "label": "L"
        }
      ],
      "supplier_id": null,
      "taxable": true,
      "title": "Classic Hoodie",
      "trashed": false,
      "type": "variant",
      "variant_count": 3,
      "variant_type": "size",
      "vendor_id": null
    }
  ],
  "pagination": {
    "count": 2,
    "currentPage": 1,
    "links": [],
    "perPage": 50,
    "total": 2,
    "totalPages": 1
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: `status` is not `on_sale`, `phased_out` or `deleted`. `error.code` is `validation_failed`. Fix: Leave it out, or use one of the three.

## Notes

- There is no keyword search on the public API. Page through this list, or keep your own index by product id.
- Read a variant product's sizes and colors, with their ids and prices, with List a product's variants or Load a product for a sales order line.

## Related

- [Get a product](https://developer.yoprint.com/reference/products/v1-products-show.md): `GET /v1/api/store/{team_slug}/product/{hash_id}`
- [Create a product](https://developer.yoprint.com/reference/products/v1-products-store.md): `POST /v1/api/store/{team_slug}/product`
- [List a product's variants](https://developer.yoprint.com/reference/product-variants/v1-product-variant-index.md): `GET /v1/api/store/{team_slug}/product/{hash_id}/variant`
- [Load a product for a sales order line](https://developer.yoprint.com/reference/products/v1-hydrate-imported-product.md): `POST /v1/api/store/{team_slug}/hydrate_product`