ConnectCloud Developers

Spent and billable time of the project against budget and plan, items by phase (desk:read). Items: GET /items?project=

GET /api/desk/v1/projects/{id}/summary

Module: Desk · operationId: getProjectSummary · Tag: Projects · Auth: access token (Authorization: Bearer <accessToken>)

Spent and billable minutes are HR's totals of the work booked with the project as reference (desk:project:<id>, ADR 0040). When HR does not answer they are null, as are remaining minutes, percent and budget state – never an error.

Parameters

Name In Type Required Description
id path string yes

Responses

  • 200 Summary (application/json)

Fields of the 200 answer:

  • billableMinutes (integer, nullable)
  • budgetMinutes (integer, nullable)
  • budgetPercent (integer, nullable)
  • budgetState (string): (one of ok, warning, exceeded)
  • items (integer)
  • itemsByPhase (object)
  • plannedMinutes (integer, nullable)
  • remainingMinutes (integer, nullable)
  • spentMinutes (integer, nullable)

Example 200 answer:

{
  "billableMinutes": 3900,
  "budgetMinutes": 9600,
  "budgetPercent": 44,
  "budgetState": "ok",
  "items": 21,
  "itemsByPhase": {
    "active": 3,
    "done": 9,
    "new": 9,
    "waiting": 0
  },
  "plannedMinutes": 8400,
  "remainingMinutes": 5340,
  "spentMinutes": 4260
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/desk/v1/projects/string/summary' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI