List estimates, proposals and contracts

Returns the estimates, proposals and contracts the token can see, newest first, without line items. Each document carries its options with their totals; unit costs and margins appear only when the token's role may edit that document. A document replaced by a later revision is left out.

Filter by kind, by deal with lead_id or job_id, and by status. The response key depends on kind: contracts when kind=contract, otherwise proposals (even when estimates are included). Results are paginated (25 per page by default, up to 100).

Sales reps see the documents on their own deals; production managers see only those on jobs assigned to them; roles with access to all records see every document in the company.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Only return documents of this kind, estimate, proposal or contract. When omitted, every kind is returned.

Allowed:
string

Only return documents on this lead's deal, including those that moved onto its job when the deal was won.

string

Only return documents attached to this job.

string
enum

Only return documents with this status, one of draft, sent, accepted, declined, signed or void.

Allowed:
integer

The page to return, starting at 1.

integer

How many documents to return per page. Defaults to 25, at most 100.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json