List estimates

GET /api/v1/estimates

List all estimates for the business with optional filtering.

Operation ID: list_estimates_api_v1_estimates_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

search string: Search estimates by description
customer_id string: Filter by customer ID
status EstimateStatusEnum: Filter by status
cursor string: Pagination cursor
limit integer default: 50: Page size

Responses

200 Successful Response

Schema: EstimatesListResponse

items array · EstimateResponse requiredEstimateResponse

List of items

28 fields

id string required
business_id string required
customer_id string required
number string
status string required
currency string required
total integer
total_in_dollars string
description string
internal_notes string
line_items object
due_date string · date-time
expiration_date string · date-time
converted_invoice_id string
sent_at string · date-time
accepted_at string · date-time
declined_at string · date-time
converted_at string · date-time
pdf_url string
created_at string · date-time required
updated_at string · date-time required
customer_name string
can_be_sent boolean
can_be_accepted boolean
can_be_declined boolean
can_be_converted boolean
can_be_updated boolean
can_be_deleted boolean

total integer

Total number of items (null when not calculated for performance)

limit integer

Pagination limit

next_cursor string

Cursor for next page

prev_cursor string

Cursor for previous page

has_next boolean required

Whether there are more items

has_prev boolean required

Whether there are previous items

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/estimates

bash

curl -X GET 'https://api.ondayzero.com/api/v1/estimates' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/estimates', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/estimates", headers=headers)
data = response.json()