---
title: "List products (up to 500, active first, newest first)"
method: GET
path: "/products"
tags: ["Products"]
---

# List products (up to 500, active first, newest first)

`GET /products`

## Request

- Base URL: `https://shieldz.cash/api/v1`
- URL: `https://shieldz.cash/api/v1/products`
- Auth: HTTP bearer

## Query parameters

- `active` boolean

## Response `200`

OK

- object
  - `object` 'list'
  - `data` Product[]
    - `id` string
    - `object` 'product'
    - `name` string: Shown to the buyer on the payment link page and on invoices.
    - `description` string, nullable: Shown under the name on the payment link page.
    - `image_url` string, uri, nullable: Product image. Images uploaded in the dashboard are served from this host.
    - `active` boolean: false once archived. Links selling an archived product show as unavailable.
    - `default_price` Price
      - `id` string
      - `object` 'price'
      - `product` string: The product (prod_…) this price belongs to.
      - `active` boolean: false once archived. An archived price can't be added to new carts or links.
      - `unit_amount_usd_cents` integer, nullable: Fixed price per unit in USD cents; null when the customer chooses the amount.
      - `custom_unit_amount` object, nullable: The range the customer chooses from; null for a fixed price.
        - `minimum_usd_cents` integer, nullable
        - `maximum_usd_cents` integer, nullable
        - `preset_usd_cents` integer, nullable
      - `created_at` integer: Unix milliseconds.
    - `created_at` integer: Unix milliseconds.
    - `updated_at` integer: Unix milliseconds.

---

[API](https://skmtc.dev/shieldz/apis/shieldz-api.md) · [All operations](https://skmtc.dev/shieldz/apis/shieldz-api/llms.txt) · [OpenAPI document](https://skmtc.dev/shieldz/apis/shieldz-api/revisions/0d7156bee439?raw)