Skip to content

List Quotes

GET
/quotes

List quotes for the org with optional status / company / deal / owner filters.

Authorizations

Parameters

Query Parameters

status
Any of:
string

Filter by quote status: draft, sent, viewed, accepted, declined, voided, expired, archived

include_archived

Also return archived quotes when no status is given

boolean

Also return archived quotes when no status is given

mashup_company_id
Any of:
integer

Filter quotes for a specific company

deal_id
Any of:
string

Filter quotes linked to a specific deal (UUID)

owner_id
Any of:
string

Filter quotes owned by a specific user (email)

page
integer
default: 1 >= 1
limit
integer
default: 50 >= 1 <= 200

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

GET /quotes envelope — preserves the original list endpoint’s pagination fields verbatim (the internal handler returns {items, total, page, limit}).

object
items
required
Array<object>

List-view row from GET /quotes. extra="allow" keeps every backend column flowing through without us re-declaring CBQuote.

object
accepted_at
Any of:
string
created_at
Any of:
string
currency
Any of:
string
id
Any of:
string
quote_number
Any of:
string
sent_at
Any of:
string
status
Any of:
string
title
Any of:
string
total
Any of:
integer
key
additional properties
any
limit
required
integer
page
required
integer
total
required
integer
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string