API reference

GETRetrieve a quote

GET /v1/quotes/{quote_id}: With quotes:asset_links, assets.*.url are durable links that work while the customer link is active (at most 30 days).

GEThttps://api.light-ai.app/v1/quotes/{quote_id}

With quotes:asset_links, assets.*.url are durable links that work while the customer link is active (at most 30 days).

Scope	`quotes:read`
Credential	API key: `Authorization: Bearer lai_live_…` (or `lai_test_…`). Partner keys add `Light-AI-Organization`.
Test mode	Works with test keys against simulated test objects.

Path parameters#

quote_idstringrequired#

The quote id (qt_…). Id prefix qt_.

Headers#

Light-AI-Organizationstring#

Partner keys: the connected organization to act for (org_…). Organization keys may omit it. Id prefix org_.

Light-AI-Versionstring#

Pin a dated API version (defaults to the key's version). One of: 2026-11-01.

Response 200#

The quote.

idstringrequired#

Id prefix qt_.

objectstringrequired#

Always quote.

livemodebooleanrequired#

false for objects created with a test key.

statusstringrequired#

One of: sent, approved, declined, expired, superseded, disabled.

is_currentbooleanrequired#

superseded_bystring | nullrequired#

Id prefix qt_.

replaces_quote_idstring | nullrequired#

Id prefix qt_.

external_refsobject[]required#

The ids integrations wrote back on this quote (PUT /v1/quotes/{id}/external_refs/{system}).

external_refs[].systemstringrequired#

external_refs[].namespacestring | nullrequired#

external_refs[].idstringrequired#

external_refs[].ownerstringrequired#

self: written by your integration (editable); others are read-only. One of: self, organization, partner.

external_refs[].read_onlybooleanrequired#

truncatedboolean#

Webhook payloads only: present (true) when the quote was too large for one delivery (256 KB). line_items is then empty; read the full quote with GET /v1/quotes/{id}. Never present on API responses. Always true.

projectobjectrequired#

project.idstringrequired#

Id prefix prj_.

project.pipeline_stagestring | nullrequired#

One of: request, quote_drafted, quote_sent, approved, completed, closed_lost.

project.external_refsobject[]required#

project.external_refs[].systemstringrequired#

project.external_refs[].namespacestring | nullrequired#

project.external_refs[].idstringrequired#

project.external_refs[].ownerstringrequired#

self: written by your integration (editable); others are read-only. One of: self, organization, partner.

project.external_refs[].read_onlybooleanrequired#

leadobject | nullrequired#

lead.idstringrequired#

Id prefix lead_.

lead.sourcestring | nullrequired#

One of: website_widget, api, google_ads_lead_form, google_lsa, meta_lead_ad, highlevel, hubspot, jobber, service_autopilot, realgreen, sweepandgo, deeplawn, zapier, n8n, make, crm_import, other, manual.

lead.external_refsobject[]required#

lead.external_refs[].systemstringrequired#

lead.external_refs[].namespacestring | nullrequired#

lead.external_refs[].idstringrequired#

lead.external_refs[].ownerstringrequired#

self: written by your integration (editable); others are read-only. One of: self, organization, partner.

lead.external_refs[].read_onlybooleanrequired#

clientobject | nullrequired#

Contact details need clients:read; otherwise only the id.

client.idstringrequired#

Id prefix cli_.

client.first_namestring | null#

client.last_namestring | null#

client.emailstring | null#

client.phonestring | null#

E.164, or null when the stored number could not be normalized (see phone_raw).

client.phone_rawstring | null#

The number as stored in Light AI.

client.external_refsobject[]#

client.external_refs[].systemstringrequired#

client.external_refs[].namespacestring | nullrequired#

client.external_refs[].idstringrequired#

client.external_refs[].ownerstringrequired#

self: written by your integration (editable); others are read-only. One of: self, organization, partner.

client.external_refs[].read_onlybooleanrequired#

propertyobject | null#

property.idstringrequired#

Id prefix prop_.

property.addressobject | null#

property.address.line1string | nullrequired#

property.address.line2string | nullrequired#

property.address.citystring | nullrequired#

property.address.regionstring | nullrequired#

property.address.postal_codestring | nullrequired#

property.address.countrystring | nullrequired#

property.address.formattedstringrequired#

Always present. Components may be null for addresses entered as one line.

property.address.latnumber | nullrequired#

property.address.lngnumber | nullrequired#

assigned_repobject | null#

assigned_rep.idstringrequired#

assigned_rep.namestring | nullrequired#

assigned_rep.emailstring | nullrequired#

titlestring | nullrequired#

messagestring | nullrequired#

termsstring | nullrequired#

disclaimerstring | null#

revisionobject#

revision.idstringrequired#

Id prefix rev_.

revision.numberintegerrequired#

revision.published_attimestamprequired#

RFC 3339 timestamp (UTC, milliseconds).

revision.evidence_hashstringrequired#

approval_modestring | nullrequired#

One of: light-ai, external, view-only.

allow_selectionsbooleanrequired#

currencystringrequired#

Always USD.

line_itemsobject[]required#

line_items[].idstringrequired#

line_items[].item_keystringrequired#

The line item id in the published document.

line_items[].codestring | nullrequired#

Stable catalog code (template line item); null for custom lines.

line_items[].namestring | nullrequired#

line_items[].descriptionstring | nullrequired#

line_items[].measurementstring | nullrequired#

line_items[].quantitynumber | nullrequired#

The measured quantity (decimal for feet and square feet, whole for counted items); null for an unmeasured line.

line_items[].unitstring | nullrequired#

One of: ft, sqft, each, set.

line_items[].unit_priceMoney | nullrequired#

Set when quantity × unit_price equals amount to the cent; otherwise null (e.g. mini lights priced by the set) and amount is the line total.

line_items[].unit_price_centsinteger | nullrequired#

line_items[].amountMoneyrequired#

line_items[].total_centsintegerrequired#

line_items[].bulbstring | nullrequired#

One of: c9, mini.

line_items[].colorsstring[]required#

line_items[].patternstring | nullrequired#

line_items[].requiredbooleanrequired#

line_items[].selectedbooleanrequired#

line_items[].taxablenullrequired#

discountobject | null#

discount.typestringrequired#

One of: percentage, fixed.

discount.valuenumberrequired#

discount.labelstring#

The discount line's name on the customer quote, e.g. "Black Friday offer" (a website request's offer); absent for a plain discount.

totalsobjectrequired#

totals.subtotalMoneyrequired#

totals.discountMoneyrequired#

totals.taxnullrequired#

totals.totalMoneyrequired#

totals.depositobjectrequired#

totals.deposit.percentagenumberrequired#

totals.deposit.amountMoneyrequired#

selected_item_idsstring[]#

linksobjectrequired#

links.customer_urlstring | nullrequired#

The homeowner's quote link. Only with the opt-in quotes:share_link scope; every read is audited.

links.app_urlstring | nullrequired#

links.external_urlstring | nullrequired#

links.external_labelstring | nullrequired#

links.pdfobject | nullrequired#

Present only when a PDF is bound to this exact revision.

links.pdf.idstringrequired#

links.pdf.sha256stringrequired#

links.assets_urlstring | null#

assetsobjectrequired#

assets.mockupsobject[]required#

assets.mockups[].idstringrequired#

assets.mockups[].titlestring | nullrequired#

The image's title as published on the quote. For a mockup: the image's own title, else its mockup card's name (cards are named from their light colors, for example "Warm White" or "Candy Cane", unless the contractor renamed them).

assets.mockups[].urlstring | nullrequired#

null (ids only) unless the credential or endpoint holds quotes:asset_links: then a durable link that works while the customer link is active (at most 30 days); null for an image no longer stored.

assets.schematicsobject[]required#

assets.schematics[].idstringrequired#

assets.schematics[].titlestring | nullrequired#

assets.schematics[].urlstring | nullrequired#

null (ids only) unless the credential or endpoint holds quotes:asset_links: then a durable link that works while the customer link is active (at most 30 days); null for an image no longer stored.

engagementobjectrequired#

engagement.availablebooleanrequired#

engagement.first_viewed_attimestamp | null#

RFC 3339 timestamp (UTC, milliseconds).

engagement.last_viewed_attimestamp | null#

RFC 3339 timestamp (UTC, milliseconds).

engagement.view_countinteger#

engagement.active_secondsnumber#

engagement.external_link_clickedboolean#

approvalobject | nullrequired#

approval.sourcestringrequired#

One of: light_ai, legacy_portal, external.

approval.signed_bystring | null#

approval.accepted_attimestamp | null#

RFC 3339 timestamp (UTC, milliseconds).

approval.selected_item_idsstring[] | null#

approval.evidence_hashstring | null#

approval.external_refobject | null#

approval.external_ref.systemstringrequired#

approval.external_ref.namespacestring | null#

approval.external_ref.idstringrequired#

declineobject | null#

decline.sourcestringrequired#

Always external.

decline.reasonstring | nullrequired#

decline.declined_attimestamp | nullrequired#

RFC 3339 timestamp (UTC, milliseconds).

decline.external_refobject | nullrequired#

decline.external_ref.systemstringrequired#

decline.external_ref.namespacestring | null#

decline.external_ref.idstringrequired#

sent_attimestamp | nullrequired#

RFC 3339 timestamp (UTC, milliseconds).

approved_attimestamp | nullrequired#

RFC 3339 timestamp (UTC, milliseconds).

declined_attimestamp | nullrequired#

RFC 3339 timestamp (UTC, milliseconds).

expires_attimestamp | nullrequired#

RFC 3339 timestamp (UTC, milliseconds).

created_attimestamprequired#

RFC 3339 timestamp (UTC, milliseconds).

updated_attimestamprequired#

RFC 3339 timestamp (UTC, milliseconds).

fixtureboolean#

Always true.

Errors#

Status	Meaning
`400`	Bad request. `bad_request`, `test_mode_mismatch`, `test_mode_unsupported`, `unsupported_api_version`
`401`	Missing or invalid credential. `authentication_required`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`, `api_key_suspended`
`403`	Not allowed. `insufficient_scope`, `plan_upgrade_required`, `organization_paused`, `organization_off_season`, `api_disabled`, `api_access_not_enabled`, `ip_not_allowed`, `forbidden`
`404`	Not found (also for objects of other organizations and for organizations without an active grant).
`422`	Validation failed. `idempotency_key_reused`
`429`	Rate limited or daily cap reached. See Retry-After and the RateLimit headers. `rate_limited`, `daily_cap_reached`
`500`	Unexpected server error. Safe to retry with exponential backoff; quote the Request-Id to support. `internal_error`
`503`	Temporarily unavailable. Retry with exponential backoff. `service_unavailable`

Request

curl -X GET "https://api.light-ai.app/v1/quotes/{quote_id}" \
  -H "Authorization: Bearer $LIGHT_AI_API_KEY"

const response = await fetch('https://api.light-ai.app/v1/quotes/{quote_id}', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LIGHT_AI_API_KEY}`,
  },
});
const data = await response.json();

import os, uuid, requests

response = requests.get(
    "https://api.light-ai.app/v1/quotes/{quote_id}",
    headers={
        "Authorization": f"Bearer {os.environ['LIGHT_AI_API_KEY']}",
    },
    timeout=30,
)
data = response.json()

Response 200JSON

{
  "id": "qt_3f9c2a7be41d…",
  "object": "quote",
  "livemode": false,
  "status": "sent",
  "is_current": true,
  "superseded_by": "qt_3f9c2a7be41d…",
  "replaces_quote_id": "qt_3f9c2a7be41d…",
  "external_refs": [
    {
      "system": "string",
      "namespace": "string",
      "id": "string",
      "owner": "self",
      "read_only": true
    }
  ],
  "truncated": true,
  "project": {
    "id": "prj_3f9c2a7be41d…",
    "pipeline_stage": "request",
    "external_refs": [
      {
        "system": "string",
        "namespace": "string",
        "id": "string",
        "owner": "self",
        "read_only": true
      }
    ]
  },
  "lead": {
    "id": "lead_3f9c2a7be41d…",
    "source": "website_widget",
    "external_refs": [
      {
        "system": "string",
        "namespace": "string",
        "id": "string",
        "owner": "self",
        "read_only": true
      }
    ]
  },
  "client": {
    "id": "cli_3f9c2a7be41d…",
    "first_name": "Dana",
    "last_name": "Reyes",
    "email": "dana@example.com",
    "phone": "+15125550134",
    "phone_raw": "string",
    "external_refs": [
      {
        "system": "string",
        "namespace": "string",
        "id": "string",
        "owner": "self",
        "read_only": true
      }
    ]
  },
  "property": {
    "id": "prop_3f9c2a7be41d…",
    "address": {
      "line1": "4102 Oak Hollow Dr",
      "line2": "string",
      "city": "Austin",
      "region": "TX",
      "postal_code": "78731",
      "country": "US",
      "formatted": "string",
      "lat": 0,
      "lng": 0
    }
  },
  "assigned_rep": {
    "id": "string",
    "name": "Dana Reyes",
    "email": "dana@example.com"
  },
  "title": "string",
  "message": "string",
  "terms": "string",
  "disclaimer": "string",
  "revision": {
    "id": "rev_3f9c2a7be41d…",
    "number": 0,
    "published_at": "2026-10-12T14:03:11.000Z",
    "evidence_hash": "string"
  },
  "approval_mode": "light-ai",
  "allow_selections": true,
  "currency": "USD",
  "line_items": [
    {
      "id": "string",
      "item_key": "string",
      "code": "string",
      "name": "Dana Reyes",
      "description": "string",
      "measurement": "string",
      "quantity": 0,
      "unit": "ft",
      "unit_price": {
        "cents": 245000,
        "decimal": "2450.00",
        "currency": "USD"
      },
      "unit_price_cents": 0,
      "amount": {
        "cents": 245000,
        "decimal": "2450.00",
        "currency": "USD"
      },
      "total_cents": 0,
      "bulb": "c9",
      "colors": [
        "string"
      ],
      "pattern": "string",
      "required": true,
      "selected": true,
      "taxable": null
    }
  ],
  "discount": {
    "type": "percentage",
    "value": 0,
    "label": "string"
  },
  "totals": {
    "subtotal": {
      "cents": 245000,
      "decimal": "2450.00",
      "currency": "USD"
    },
    "discount": {
      "cents": 245000,
      "decimal": "2450.00",
      "currency": "USD"
    },
    "tax": null,
    "total": {
      "cents": 245000,
      "decimal": "2450.00",
      "currency": "USD"
    },
    "deposit": {
      "percentage": 0,
      "amount": {
        "cents": 245000,
        "decimal": "2450.00",
        "currency": "USD"
      }
    }
  },
  "selected_item_ids": [
    "string"
  ],
  "links": {
    "customer_url": "https://example.com/…",
    "app_url": "https://example.com/…",
    "external_url": "https://example.com/…",
    "external_label": "string",
    "pdf": {
      "id": "string",
      "sha256": "string"
    },
    "assets_url": "https://example.com/…"
  },
  "assets": {
    "mockups": [
      {
        "id": "string",
        "title": "string",
        "url": "https://example.com/…"
      }
    ],
    "schematics": [
      {
        "id": "string",
        "title": "string",
        "url": "https://example.com/…"
      }
    ]
  },
  "engagement": {
    "available": true,
    "first_viewed_at": "2026-10-12T14:03:11.000Z",
    "last_viewed_at": "2026-10-12T14:03:11.000Z",
    "view_count": 1,
    "active_seconds": 0,
    "external_link_clicked": true
  },
  "approval": {
    "source": "light_ai",
    "signed_by": "Dana Reyes",
    "accepted_at": "2026-10-12T14:03:11.000Z",
    "selected_item_ids": [
      "string"
    ],
    "evidence_hash": "string",
    "external_ref": {
      "system": "string",
      "namespace": "string",
      "id": "string"
    }
  },
  "decline": {
    "source": "external",
    "reason": "string",
    "declined_at": "2026-10-12T14:03:11.000Z",
    "external_ref": {
      "system": "string",
      "namespace": "string",
      "id": "string"
    }
  },
  "sent_at": "2026-10-12T14:03:11.000Z",
  "approved_at": "2026-10-12T14:03:11.000Z",
  "declined_at": "2026-10-12T14:03:11.000Z",
  "expires_at": "2026-10-12T14:03:11.000Z",
  "created_at": "2026-10-12T14:03:11.000Z",
  "updated_at": "2026-10-12T14:03:11.000Z",
  "fixture": true
}