Get Estimates By Group Filter

Changed on

Kanban board lists: per-status paginated estimate lists, grouped by estimate_status. Same fixed-status-group model as Get Estimates Summary — no job_category_uid-style dynamic grouping field exists for Estimate.

Each estimate in the response uses a fixed projection (not configurable) — note that fields_to_select has no effect on this endpoint even though it's accepted on the plain Estimate list endpoint. The response field sold_by_user is renamed to sold_by; created_by keeps its name. cpq_status is not included in the projection.

post/estimate/group/filter

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/estimate/group/filter
  • Auth
    API key in header x-api-key

Request body

sort'ASC' | 'DESC'
sort_by'created_at' | 'updated_at' | 'estimate_date' | 'total'
countinteger

Max estimates returned per status group.

filter_rulesobject[]
filter_rule_operator'AND' | 'OR'

Response

200

Changes