List Estimates
GET/invoices/estimate/list
Get a paginated list of estimates
Request
Version stringrequired
API Version
Available options
v3altId stringrequired
Location Id or Agency Id
altType stringrequired
Available options
locationstartAt string
startAt in YYYY-MM-DD format
endAt string
endAt in YYYY-MM-DD format
search string
search text for estimates name
status string
estimate status
Available options
alldraftsentaccepteddeclinedinvoicedviewedcontactId string
Contact ID for the estimate
limit stringrequired
Limit the number of items to return
offset stringrequired
Number of items to skip
Successful response
- application/json
- Schema
- Example (auto)
Schema
estimatesstring[]required
List of estimates
totalnumberrequired
Total number of estimates
traceIdstringrequired
Unique identifier for tracing the request
{
"estimates": [
"string"
],
"total": 0,
"traceId": "string"
}