Aggregate project totals and breakdowns by status and type

GET

/projects/summary

• Production

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.

Authorizations

• bearerAuth
  projects:read

Parameters

Query Parameters

dateFrom

string format: date-time

dateTo

string format: date-time

contactId

integer

> 0

assignedTo

integer

> 0

Responses

200

Project summary

object

data

required

object

totals

required

object

count

required

integer

contract_value_total

required

string

approved_co_delta_total

required

string

overdue_count

required

integer

by_status

required

Array<object>

object

status

required

string

count

required

integer

contract_value_total

required

string

by_type

required

Array<object>

object

project_type

required

string | null

count

required

integer

contract_value_total

required

string

meta

required

object

request_id

Server-generated request identifier

string

pagination

object

cursor

required

Opaque cursor for the next page; null when no more results

string | null

has_more

required

Whether more pages are available after this one

boolean

count

required

Items in this page

integer

403

Scope insufficient

object

type

required

URL identifying the problem type

string format: uri

title

required

Short human-readable summary

string

status

required

HTTP status code

integer

detail

Human-readable explanation

string

request_id

Server-generated request identifier

string

errors

Validation error array (422 only)

Array<object>

object

field

required

Field path that failed validation

string

code

required

Validation error code

string

message

required

Human-readable validation message

string

422

Validation failed

object

type

required

URL identifying the problem type

string format: uri

title

required

Short human-readable summary

string

status

required

HTTP status code

integer

detail

Human-readable explanation

string

request_id

Server-generated request identifier

string

errors

Validation error array (422 only)

Array<object>

object

field

required

Field path that failed validation

string

code

required

Validation error code

string

message

required

Human-readable validation message

string