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

# Retrieve a quote

> One quote. An id that names no quote in the workspace is `quote_not_found`. **Requires scope:** `billing:read`.



## OpenAPI

````yaml /openapi-v1.json get /v1/quotes/{id}
openapi: 3.1.0
info:
  title: Custral API
  version: v1
  description: >-
    The curated, versioned, API-key-authenticated public REST surface (`/v1`).
    Every endpoint here is what the official SDKs (`@custral/sdk`) and the MCP
    server are built on. Authenticate with a secret API key (`sk_…`) created in
    **Settings → Developers → Applications**.


    Every `/v1` response is sent with **HTTP 200**, success and failure alike. A
    success carries `data`; a failure carries `error` with a machine-readable
    `code` (see the `Error` schema), so branch on `error`, never on the status.
    `POST /v1/mcp` is the one exception: it answers auth failures with real 401
    / 403 / 429 statuses, as MCP clients expect.
  contact:
    name: Custral Support
    email: hello@custral.com
    url: https://custral.com
  license:
    name: Proprietary
    url: https://custral.com
servers:
  - url: https://api.custral.com
    description: Production
security:
  - ApiKey: []
tags:
  - name: Identity
    description: Introspect the calling API key.
  - name: Records
    description: Create, list, retrieve, and update records on any object.
  - name: Objects
    description: Read the object (table) schema of your workspace.
  - name: Conversations
    description: View, manage, and ingest conversations and their messages.
  - name: MCP
    description: Custral's MCP server, and the tool surface a key sees on it.
  - name: Documents
    description: Read record notes / page documents as markdown.
  - name: Connectors
    description: The MCP servers Stella can use tools from.
  - name: Property agents
    description: AI auto-fill agents on properties.
  - name: Usage modules
    description: Metered-product setups, their usage events, and per-record usage.
  - name: Applications & keys
    description: Developer applications and the API keys they hold.
  - name: Widget identity
    description: Vouch for who a chat widget visitor is.
  - name: Embeds & real-time
    description: Read the rows behind your own embed block, with an embed token.
  - name: Lists
    description: Read lists and change who is on them.
  - name: Customer journeys
    description: The workspace's customer journey, and where each customer is in it.
  - name: Quotes
    description: Quotes, contracts and contract templates.
  - name: Billing
    description: >-
      Customer billing, invoices, subscriptions, revenue metrics, the billing
      page, Stripe customer links, billing setup, products and plans.
paths:
  /v1/quotes/{id}:
    get:
      tags:
        - Quotes
      summary: Retrieve a quote
      description: >-
        One quote. An id that names no quote in the workspace is
        `quote_not_found`. **Requires scope:** `billing:read`.
      operationId: getQuote
      parameters:
        - name: id
          in: path
          required: true
          description: The quote's id.
          schema:
            type: string
      responses:
        '200':
          description: The quote.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Quote'
                  reqId:
                    $ref: '#/components/schemas/RequestId'
components:
  schemas:
    Quote:
      type: object
      description: A quote. Amounts are in minor units (cents).
      properties:
        id:
          type: string
        number:
          type: string
          description: The label a person reads.
          example: Q-0007
        status:
          type: string
          enum:
            - draft
            - sent
            - viewed
            - accepted
            - declined
            - expired
            - void
        customer:
          type: object
          properties:
            recordId:
              type: string
            name:
              type:
                - string
                - 'null'
              example: Hooli
        contactName:
          type:
            - string
            - 'null'
        contactEmail:
          type:
            - string
            - 'null'
        currency:
          type: string
          example: usd
        collectionMethod:
          type: string
          enum:
            - autopay
            - invoice
        paymentTermsDays:
          type: integer
        trialDays:
          type: integer
        billingEvery:
          type: integer
          description: >-
            Recurring lines bill every N intervals (3 with monthly lines is
            quarterly).
        billingAnchorDay:
          type:
            - integer
            - 'null'
          description: >-
            Day of the month recurring lines bill on; null bills from
            acceptance.
        requireSignature:
          type: boolean
        contractTemplateId:
          type:
            - string
            - 'null'
          description: Null means the workspace's default contract.
        startDate:
          type:
            - string
            - 'null'
        expiresAt:
          type:
            - string
            - 'null'
        sentAt:
          type:
            - string
            - 'null'
          format: date-time
        acceptedAt:
          type:
            - string
            - 'null'
          format: date-time
        acceptedName:
          type:
            - string
            - 'null'
        createdAt:
          type:
            - string
            - 'null'
          format: date-time
        url:
          type: string
          description: >-
            The hosted page the customer accepts on. Opens once the quote is
            sent.
        lineItems:
          type: array
          items:
            $ref: '#/components/schemas/QuoteLineItem'
        discount:
          oneOf:
            - $ref: '#/components/schemas/QuoteDiscount'
            - type: 'null'
        paymentSchedule:
          type: array
          items:
            $ref: '#/components/schemas/QuoteInstalment'
        billingError:
          type:
            - string
            - 'null'
          description: Why billing failed to start after acceptance; null otherwise.
        totals:
          type: object
          properties:
            recurring:
              type: array
              items:
                type: object
                properties:
                  interval:
                    type: string
                  listAmount:
                    type: integer
                    description: Per period before discounts, in minor units.
                  phases:
                    type: array
                    items:
                      type: object
                      properties:
                        fromPeriod:
                          type: integer
                        toPeriod:
                          type:
                            - integer
                            - 'null'
                        amount:
                          type: integer
                    description: What each run of periods bills.
            oneTimeListTotal:
              type: integer
            oneTimeTotal:
              type: integer
      required:
        - id
        - number
        - status
        - customer
        - url
    RequestId:
      type: string
      description: >-
        A per-request id (`req_…`). Quote it to support when reporting a
        problem.
      example: req_2a1f9c8e7b6d5
    QuoteLineItem:
      type: object
      properties:
        productRecordId:
          type: string
        name:
          type: string
          example: Pro seats
        description:
          type: string
        quantity:
          type: integer
        unitAmount:
          type: integer
          description: Per unit, in minor units (cents).
        interval:
          type: string
          enum:
            - one_time
            - month
            - year
        usageEvent:
          type: string
          description: Set on a metered line, which bills per unit through usage.
    QuoteDiscount:
      type: object
      description: A discount. On a quote read, an `amount` is in minor units.
      properties:
        type:
          type: string
          enum:
            - percent
            - amount
        value:
          type: number
          description: A percent (20 for 20%, at most 100) or an amount.
        duration:
          type: string
          enum:
            - once
            - repeating
            - forever
        months:
          type: integer
          description: For `repeating` only.
          minimum: 1
          maximum: 120
    QuoteInstalment:
      type: object
      properties:
        label:
          type: string
        due:
          type: string
          description: '`on_acceptance` or a `YYYY-MM-DD` date.'
        type:
          type: string
          enum:
            - percent
            - amount
        value:
          type: number
        billedAt:
          type: string
          description: Set once the instalment has been invoiced.
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: sk_...
      description: >-
        A Custral API key, created in Settings → Developers → Applications, sent
        as `Authorization: Bearer sk_…`. The `X-Api-Key` header is also accepted
        and takes precedence. Use a **secret** key (`sk_…`) from your server; a
        publishable key (`pk_…`) may hold only `objects:read` and `usage:write`.
        Never expose a secret key in a browser.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.