> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heffl.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List quotations

> Returns a paginated list of quotations. Supports cursor pagination, full-text search, structured filters (status, client, sales person, tags, dates), and sorting. Results respect the API key user's ownership permissions. See the [Listing & filters](/api-v2/listing-and-filters) guide for filter syntax.



## OpenAPI

````yaml /openapi.v2.json get /quotations
openapi: 3.1.1
info:
  title: Heffl API v2 (Beta)
  version: 2.0.0
  description: >-
    Heffl REST API v2 (beta) — resource-oriented endpoints with consistent
    response envelopes. Endpoints, schemas, and behavior may change until GA.
    See Agent workflows and ID prefixes guides for automation.
  contact:
    name: Heffl Support
    url: https://heffl.com/support
    email: support@heffl.com
servers:
  - url: https://api.heffl.com/api/v2
    description: Production API Server
security:
  - ApiKeyAuth: []
paths:
  /quotations:
    get:
      tags:
        - Objects
      summary: List quotations
      description: >-
        Returns a paginated list of quotations. Supports cursor pagination,
        full-text search, structured filters (status, client, sales person,
        tags, dates), and sorting. Results respect the API key user's ownership
        permissions. See the [Listing & filters](/api-v2/listing-and-filters)
        guide for filter syntax.
      operationId: objects.quotations.list
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            Cursor for pagination. Pass the previous response meta.nextCursor
            value to fetch the next page.
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 30
          description: Number of items to return per page (max 100)
        - name: search
          in: query
          required: false
          schema:
            type: string
          description: Search by number, subject, client name, or line item text
        - name: orderBy
          in: query
          required: false
          schema:
            type: string
            enum:
              - createdAt
              - date
              - number
              - expiryDate
            default: createdAt
          description: Field to sort results by
        - name: orderDir
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          description: Sort direction
        - name: filters
          in: query
          required: false
          schema:
            type: object
            description: >-
              Structured filters (status, clientId, salesPersonId, tagId,
              productId, templateId, dealId, dates). Option values use prefixed
              string IDs. See the Listing & filters guide.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Quotation'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
        '400':
          description: Validation error or bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '403':
          description: Insufficient permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
components:
  schemas:
    Quotation:
      type: object
      required:
        - id
        - number
        - date
        - status
        - currency
        - createdAt
      properties:
        id:
          type: string
          description: Quotation ID (qtn_ prefix)
        number:
          type: string
          description: Auto-generated quotation number
        date:
          type: string
          format: date-time
          description: Quotation date
        status:
          type: string
          enum:
            - DRAFT
            - SENT
            - ACCEPTED
            - REJECTED
          description: Quotation status
        subject:
          anyOf:
            - type: string
            - type: 'null'
          description: Subject
        expiryDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: Expiry date
        currency:
          type: string
          description: ISO 4217 currency code
        conversionRate:
          type: number
          description: Quotation currency to team currency rate
        isInclusiveTax:
          type: boolean
          description: Whether prices include tax
        clientId:
          anyOf:
            - type: string
            - type: 'null'
          description: Contact or company ID (clt_ prefix)
        contactId:
          anyOf:
            - type: string
            - type: 'null'
          description: Optional contact person ID (clt_ prefix) when clientId is a company
        dealId:
          anyOf:
            - type: string
            - type: 'null'
          description: Deal ID (dl_ prefix)
        salesPersonId:
          anyOf:
            - type: string
            - type: 'null'
          description: Sales person user ID (usr_ prefix)
        templateId:
          anyOf:
            - type: string
            - type: 'null'
          description: Document template ID (tpl_ prefix)
        contentHtml:
          anyOf:
            - type: string
            - type: 'null'
          description: Rendered document HTML
        internalNotes:
          anyOf:
            - type: string
            - type: 'null'
          description: Internal notes
        totalAmount:
          type: number
          description: Total including tax
        subtotalAmount:
          type: number
          description: Subtotal before tax
        totalTaxAmount:
          type: number
          description: Total tax amount
        totalDiscountAmount:
          type: number
          description: Total discount amount
        tagIds:
          type: array
          items:
            type: string
          description: Tag IDs (tag_ prefix)
        lineItems:
          type: array
          items:
            $ref: '#/components/schemas/QuotationLineItem'
          description: Line items (included on get; empty on list)
        markedAcceptedOn:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: When the quotation was accepted
        markedRejectedOn:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: When the quotation was rejected
        createdAt:
          type: string
          format: date-time
        updatedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
      additionalProperties:
        description: Custom field values using cf_* keys
    ListMeta:
      type: object
      properties:
        nextCursor:
          type:
            - string
            - 'null'
          description: Cursor to fetch the next page. Null if there are no more results.
        hasMore:
          type: boolean
          description: Whether additional results are available
      required:
        - hasMore
    V2ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
    QuotationLineItem:
      type: object
      required:
        - name
        - quantity
        - price
      properties:
        name:
          type: string
          description: Line item name
        productId:
          anyOf:
            - type: string
            - type: 'null'
          description: Product ID (prd_ prefix)
        quantity:
          type: number
          description: Quantity
        price:
          type: number
          description: Unit price
        description:
          anyOf:
            - type: string
            - type: 'null'
          description: Line item description
        tax:
          type: number
          description: Tax percentage when taxRateId is omitted
        taxRateId:
          anyOf:
            - type: string
            - type: 'null'
          description: Tax rate ID (txr_ prefix)
        discount:
          type: number
          description: Discount value
        discountType:
          type: string
          enum:
            - fixed
            - percent
          description: Discount type
        viewType:
          type: string
          enum:
            - LINE_ITEM
            - HEADING
          description: Line display type
        scope:
          anyOf:
            - type: string
            - type: 'null'
          description: Optional scope label
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Get yours at
        app.heffl.com/settings/developers

````