WOworkiz
Estimates

Retrieve a list of Estimates

Changed on

Retrieves a paginated list of Estimates, optionally filtered by date range.

get/v2/estimates

Request

Query parameters

pageSizenumber
Example:10

Number of records to return per page.

pagenumber
Example:1

The page index.

field'created'

Beta: This property is subject to change.

The field to sort results by. Must be combined with order.

order'ASC' | 'DESC'

Beta: This property is subject to change.

The sort direction. Must be combined with field. Defaults to DESC.

dateProperty'updated' | 'created'

The estimate date field to apply the date filter to. Must be combined with dateOperator and date.

dateOperator'prev' | 'next' | 'between'

Comparison operator for the date filter. Must be combined with dateProperty and date.

datestring

Date value(s) for the filter. Format depends on dateOperator: prev / next accept a single date (YYYY-MM-DD); between accepts two dates separated by _ (YYYY-MM-DD_YYYY-MM-DD).

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

A paginated list of Estimates.

pageSizenumber

The maximum number of items returned per page.

pagenumber

The current page number.

totalResultsnumber

The total number of results.

hasMoreboolean

Whether there are more results.

Example response

{
  "pageSize": 10,
  "page": 1,
  "totalResults": 50,
  "hasMore": true,
  "data": [
    {
      "id": "ES-LwqGJnRwvZPaNe5E",
      "status": "Pending",
      "serialId": "1-1",
      "name": "Estimate 1",
      "description": "This is a description for the estimate",
      "notes": "This is a note for the estimate",
      "imageUrl": "https://example.com/image.png",
      "clientId": "CL-LwqGJnRwvZPaNe5E",
      "jobId": "JOB-BA5r7o4bqzR9MONa",
      "taxPercent": 10,
      "taxableAmount": 100,
      "taxAmount": 10,
      "isDepositPercentage": true,
      "deposit": 100,
      "subTotal": 10,
      "total": 10,
      "declineReason": "This is a decline reason for the estimate",
      "sentDate": "2026-01-01 00:00:00",
      "estimateDate": "2026-01-01 00:00:00",
      "lastViewedDate": "2026-01-01 00:00:00",
      "statusUpdatedAt": "2026-01-01 00:00:00",
      "updated": "2026-01-01 00:00:00",
      "created": "2026-01-01 00:00:00"
    }
  ]
}

Changes

  • a2110eaa32f2Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • c308fa019f29Revision changes
    • info

      added the new optional query request parameter field

    • info

      added the new optional query request parameter order