---
title: "Get Estimates"
method: GET
path: "/v2/customer_portal/estimates"
---

# Get Estimates

`GET /v2/customer_portal/estimates`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/v2/customer_portal/estimates`
- Auth: API key in header `x-api-key`

## Query parameters

- `page` integer, required
- `count` integer, required
- `sort` 'DESC' | 'ASC', required
- `sort_by` 'estimate_no' | 'total' | 'created_at' | 'estimate_date' | 'expiry_date', required
- `filter.estimate_status` 'AWAIT_RESPONSE' | 'APPROVED' | 'DECLINED' | 'CLOSED' | 'CANCELED' | 'REQUEST_CHANGE'
- `filter.estimate_from_date` string, date
- `filter.estimate_to_date` string, date
- `filter.expiry_from_date` string, date
- `filter.expiry_to_date` string, date
- `filter.job` string
- `filter.organization` string
- `filter.property` string
- `filter.keyword` string

## Response `200`

200

- object
  - `type` string
  - `data` object[]
    - `estimate_uid` string
    - `prefix` string
    - `reference_no` string
    - `estimate_date` string
    - `expiry_date` string
    - `customer` object
      - `customer_uid` string
      - `customer_first_name` string
      - `customer_last_name` string
    - `organization` object
      - `organization_uid` string
      - `organization_name` string
    - `job` unknown
    - `fees` unknown[]
      - unknown
    - `total` integer
    - `estimate_status` string
    - `custom_fields` object[]
      - `label` string
      - `value` string
      - `type` string
      - `module_name` string
      - `hide_to_fe` boolean
      - `hide_field` boolean
      - `read_only` boolean
      - `_id` string
    - `deposit` object
    - `is_expired` boolean
    - `is_converted` boolean
    - `financing` object
      - `promo_message` string
      - `is_enabled` boolean
    - `is_proposal` boolean
    - `proposal_title` string
    - `proposal_options` object[]
      - `option_uid` string
      - `option_name` string
    - `created_at` string
    - `updated_at` string
    - `estimate_no` integer
  - `current_page_records` integer
  - `total_records` integer
  - `current_page` integer
  - `total_pages` integer

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/v2/customer_portal/estimates/get.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)