---
title: "Get all price lists"
method: GET
path: "/api-offers/price-list"
tags: ["Price List"]
---

# Get all price lists

`GET /api-offers/price-list`

## Request

- Base URL: `https://live.copilot.fabric.inc`
- URL: `https://live.copilot.fabric.inc/api-offers/price-list`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/fabric/apis/offers-v2/docs/api-offers/price-list/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a paginated list of all price lists.

## Query parameters

- `limit` number
- `offset` number
- `sortBy` 'updatedAt' | 'name' | 'priceListId'
- `sortOrder` 'asc' | 'desc'
- `filter` 'not_expired'
- `isDefault` true | false

## Headers

- `x-site-context` string, required

## Response `200`

OK

- PriceListResponse
  - `query` GenericListQueryResponse: Paging details used for selecting list
    - `limit` number: The maximum number of records per page.
    - `count` number: The total number of records.
    - `offset` number: The number of records to skip before returning records. For example, when offset is 20 and limit is 10, this endpoint returns records from 21 to 30.
  - `data` PriceList[]: Price list data
    - `_id` string: fabric internal unique id
    - `priceListId` number: Price list ID. This is the system generated unique ID of the pricelist
    - `name` string: Price list name
    - `isDefault` boolean: true: This is the default price list<br /> false: This is not the default price list
    - `currency` string, iso-4217: 3 letter currency code as defined by ISO-4217
    - `startDate` string, date-time, nullable: Start date of the price list. This value can be `null`. However, if start date is mentioned, end date must also be mentioned.
    - `endDate` string, date-time, nullable: The end date of priceList. This value can be `null`. However, if end date is mentioned, start date must also be mentioned.
    - `deleted` boolean: true: Price list is deleted<br /> false: Price list is not deleted
    - `createdAt` string, date-time: Creation date of the record
    - `updatedAt` string, date-time: Last updated date of the record

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/fabric/apis/offers-v2.md) - [All operations](https://skmtc.dev/fabric/apis/offers-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/fabric/apis/offers-v2/revisions/da2bd742b9bc?raw)