---
title: "Aggregate project totals and breakdowns by status and type"
method: GET
path: "/projects/summary"
tags: ["Projects"]
---

# Aggregate project totals and breakdowns by status and type

`GET /projects/summary`

## Request

- Base URL: `https://app.buildworkpro.com/api/v1`
- URL: `https://app.buildworkpro.com/api/v1/projects/summary`
- Auth: HTTP bearer

Returns totals (count, contract_value_total, approved_co_delta_total, overdue_count) plus breakdowns by status and by project type. Money values are decimal strings. Date filter applies to createdAt and is inclusive on both bounds.

## Query parameters

- `dateFrom` string, date-time
- `dateTo` string, date-time
- `contactId` integer
- `assignedTo` integer

## Response `200`

Project summary

- object
  - `data` object, required
    - `totals` object, required
      - `count` integer, required
      - `contract_value_total` string, required
      - `approved_co_delta_total` string, required
      - `overdue_count` integer, required
    - `by_status` object[], required
      - `status` string, required
      - `count` integer, required
      - `contract_value_total` string, required
    - `by_type` object[], required
      - `project_type` string, nullable, required
      - `count` integer, required
      - `contract_value_total` string, required
  - `meta` ResponseMeta, required
    - `request_id` string: Server-generated request identifier
    - `pagination` PaginationMeta
      - `cursor` string, nullable, required: Opaque cursor for the next page; null when no more results
      - `has_more` boolean, required: Whether more pages are available after this one
      - `count` integer, required: Items in this page

## Other responses

- `403`: Scope insufficient
- `422`: Validation failed

---

[API](https://skmtc.dev/buildworkpro/apis/buildworkpro-api.md) · [All operations](https://skmtc.dev/buildworkpro/apis/buildworkpro-api/llms.txt) · [OpenAPI document](https://skmtc.dev/buildworkpro/apis/buildworkpro-api/revisions/441cf40012f7?raw)