---
title: "List price books"
method: GET
path: "/price_books"
tags: ["Price Books"]
---

# List price books

`GET /price_books`

Returns a paginated list of price books.

🔒 Requires: `products:read:price_books` `customers:read` `outlets:read` scopes

## Query parameters

- `after` integer
- `before` integer
- `page_size` integer
- `order` string
- `direction` string
- `deleted` boolean
- `customer_group_id` string

## Response `200`

- PriceBookCollection
  - `data` PriceBook[] — An array of Price Book objects wrapped in a top level `data` object.
    - `created_at` string — Created timestamp in UTC.
    - `customer_group_ids` string[], nullable — The IDs of the customer groups associated with this price book.
    - `customer_groups` CustomerGroup[], nullable
      - `created_at` string — Creation timestamp in UTC.
      - `deleted_at` string, nullable — Deletion timestamp in UTC.
      - `group_id` string — The customer group identifier.
      - `id` string — Auto-generated object ID.
      - `name` string, required — The customer group name.
      - `retailer_id` string — The retailer identifier
      - `updated_at` string — Last update timestamp in UTC.
      - `version` integer — Auto-incrementing object version number.
    - `deleted_at` string, nullable — Deletion timestamp in UTC.
    - `id` string — Auto-generated object ID.
    - `name` string, required — Price Book name.
    - `outlets` Outlet[], nullable
      - `attributes` Attribute[], required — The outlet attributes such as `low_stock_warning`, `order_reference`, `order_reference_prefix`, `return_reference`, `return_reference_prefix`.
        - `key` string, required — The key for the attribute.
        - `value` string, required — The value for the attribute.
      - `currency` string, required — Currency name.
      - `currency_symbol` string, required — Currency symbol.
      - `default_tax_id` string, required — Default tax id used for sales in this outlet. **deprecated**
      - `deleted_at` string, nullable — Deletion timestamp in UTC.
      - `display_prices` 'inclusive' | 'exclusive', required — Indicates whether prices in this outlet should be displayed as tax-inclusive.
      - `email` string — Specified email for the outlet.
      - `id` string, required — Auto-generated object ID.
      - `latitude` string, nullable — Geographical latitude of the outlet.
      - `longitude` string, nullable — Geographical longitude of the outlet.
      - `name` string, required — The outlet name.
      - `phone` string, nullable — Contact phone number for the outlet.
      - `physical_address_1` string, nullable — Physical address, line 1.
      - `physical_address_2` string, nullable — Physical address, line 2.
      - `physical_city` string, nullable — Physical address, city.
      - `physical_country_id` string, nullable — Physical address, country code.
      - `physical_postcode` string, nullable — Physical address, post code.
      - `physical_state` string, nullable — Physical address, state.
      - `physical_suburb` string, nullable — Physical address, suburb.
      - `time_zone` string, nullable, required — Outlet timezone. **read only**
      - `version` integer, required — Auto-incrementing object version number.
    - `restrict_to_platform_key` string, nullable — `"0"` - all platforms, `"1"` - in store, `"2"` - ecommerce.
    - `restrict_to_platform_label` string, nullable — One of `In Store`, `Ecommerce`, `All Platforms`.
    - `type` string — Type of price book
    - `updated_at` string — Updated timestamp in UTC.
    - `valid_from` string, nullable — The date when the Price Book becomes valid (active).
    - `valid_to` string, nullable — The date when the Price Book becomes invalid (inactive).
    - `version` integer — Auto-incrementing object version number.

---

[API](https://skmtc.net/lightspeedhq/apis/api-2026-07.md) · [All operations](https://skmtc.net/lightspeedhq/apis/api-2026-07/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightspeedhq/api-2026-07/revisions/72d4ceb46dbb/schema)