---
title: "Get a list of quotes"
method: GET
path: "/quotes"
tags: ["Quotes"]
---

# Get a list of quotes

`GET /quotes`

## Query parameters

- `filter[lead]` string
- `filter[dateMin]` string
- `filter[dateMax]` string
- `page[limit]` string
- `page[page]` string

## Response `200`

A list of quotes

- object
  - `quotes` Quote[] — An array of quote objects
    - `id` string — The API ID of this entity, formatted {integer}-{entityType}
    - `displayStatus` 'DRAFT' | 'READY' | 'SENT' | 'REVOKED' | 'ACCEPTED' | 'ARCHIVED' | 'EXPIRED' — The current status of the sales document. For invoices, ACCEPTED means paid.
    - `productLineItems` SalesDocumentProductLineItem[] — The products and services included in the sales document.
      - `id` string — The line item ID
      - `position` integer — Sort order of the line item on the document
      - `product` string, nullable — The product ID this line item references, if any
      - `name` string — Display name of the line item
      - `description` string — Description of the line item
      - `sku` string — SKU of the line item
      - `quantity` number, float — Quantity of the line item
      - `term` string, nullable — Billing period unit for the line item, if any (minute, hour, day, week, month, quarter, or year)
      - `price` Value
        - `formatted` string — The value formatted as a string
        - `amount` string — The value as a number
        - `currency` string — The currency code
      - `total` Value
        - `formatted` string — The value formatted as a string
        - `amount` string — The value as a number
        - `currency` string — The currency code
      - `discountUnit` string, nullable — Discount unit: '$' for a fixed amount, or '%' for a percentage
      - `discountNumber` number, float, nullable — Discount amount or percentage, depending on discountUnit
    - `subtotalLineItems` SalesDocumentSubtotalLineItem[] — Adjustments applied after the product subtotal, such as tax, shipping, or discounts.
      - `id` string — The subtotal line item ID
      - `position` integer — Sort order of the adjustment on the document
      - `label` string — Display label for the adjustment
      - `modifierUnit` string — Modifier unit: '$' for a fixed amount, or '%' for a percentage
      - `modifierValue` number, float — Modifier amount or percentage, depending on modifierUnit
      - `operation` '+' | '-' — Whether the modifier is added (+) or subtracted (-)
      - `total` Value
        - `formatted` string — The value formatted as a string
        - `amount` string — The value as a number
        - `currency` string — The currency code
    - `recipient` SalesDocumentRecipient, nullable — The contact or company selected as the document recipient
      - `id` string — The recipient entity ID; entity type is encoded in the API id suffix (e.g. contacts or accounts)
      - `name` string — Display name of the recipient
      - `email` string, nullable — Email address used for the recipient on this document
    - `acceptedName` string, nullable — Name recorded when the document was accepted or marked paid
    - `acceptedEmail` string, nullable — Email recorded when the document was accepted or marked paid
    - `number` string — The quote number
    - `total` Value
      - `formatted` string — The value formatted as a string
      - `amount` string — The value as a number
      - `currency` string — The currency code
    - `validThroughTime` string — The date and time when the quote expires or is no longer valid
    - `createdTime` string — The date and time when the quote was created
    - `publishedTime` string — The date and time when the quote was published
    - `sentTime` string — The date and time when the quote was sent to the customer
    - `acceptedTime` string — The date and time when the quote was accepted by the customer
    - `deletedTime` string — The date and time when the quote was deleted
  - `meta` Meta — Information about the Nutshell instance making the request
    - `instanceId` string — The Nutshell instance ID
    - `siteId` string — Site ID for WebFX customers
  - `links` object — Pagination links

---

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