Skip to main content
EstimateVersion: v3

List Estimates

GET/invoices/estimate/list

Get a paginated list of estimates

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:invoices/estimate.readonly
Auth methods:OAuthPrivate Integration
Token types:Sub-Account TokenAgency Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Query Parameters

altIdstringrequired

Location Id or Agency Id

Example:6578278e879ad2646715ba9c
altTypestringrequired
Available optionslocation
startAtstring

startAt in YYYY-MM-DD format

Example:2023-01-01
endAtstring

endAt in YYYY-MM-DD format

Example:2023-01-01
searchstring

search text for estimates name

Example:Home services estimate
statusstring

estimate status

Available optionsalldraftsentaccepteddeclinedinvoicedviewed
Example:sent
contactIdstring

Contact ID for the estimate

Example:AmuzcoPBpgKeccNsFlib
limitstringrequired

Limit the number of items to return

Example:10
offsetstringrequired

Number of items to skip

Example:10

Response

application/json

Successful response

estimatesstring[]required

List of estimates

totalnumberrequired

Total number of estimates

traceIdstringrequired

Unique identifier for tracing the request