Skip to content

Search Quote Contacts

GET
/quote-contacts

Find a contact to put on a quote as signer or billing contact.

Authorizations

Parameters

Query Parameters

q

Name or email fragment. Empty returns the default page.

string
"" <= 200 characters

Name or email fragment. Empty returns the default page.

limit

The app’s default is 100 and deliberately not smaller: the signer picker has to show every plausible match, and a short page reads as ‘this contact does not exist’.

integer
default: 100 >= 1 <= 500

The app’s default is 100 and deliberately not smaller: the signer picker has to show every plausible match, and a short page reads as ‘this contact does not exist’.

company_id
Any of:
integer

Scope to contacts at this company.

deal_id
Any of:
string

Scope to contacts linked to this deal. Combined with company_id the two scopes are a UNION - on the deal OR at the company - and each row comes back with an on_deal flag. Given deal_id alone, the company is derived from the deal.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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