Skip to main content
GET
/
api
/
plan
/
{boardId}
/
capacity
Calculates capacity for a board cycle: per-resource hours, utilization, and aggregates.
curl --request GET \
  --url https://{tenant}.ekso.app/api/plan/{boardId}/capacity \
  --header 'Authorization: Bearer <token>'
{
  "boardId": "<string>",
  "cycleId": "<string>",
  "boardBudgetHours": 123,
  "cycleBudgetHours": 123,
  "cyclePlannedHours": 123,
  "resources": [
    {
      "userId": "<string>",
      "userName": "<string>",
      "totalCapacityHours": 123,
      "plannedHours": 123,
      "availableHours": 123,
      "utilizationPercent": 123,
      "plannedCost": 123,
      "plannedRevenue": 123
    }
  ],
  "aggregate": {
    "totalCapacityHours": 123,
    "totalPlannedHours": 123,
    "totalAvailableHours": 123,
    "utilizationPercent": 123,
    "totalPlannedCost": 123,
    "totalPlannedRevenue": 123,
    "grossMarginPercent": 123,
    "totalLoggedCost": 123,
    "totalLoggedRevenue": 123
  }
}

Authorizations

Authorization
string
header
required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Path Parameters

boardId
string
required

The board ID.

Query Parameters

cycleId
string

The cycle ID.

Response

Capacity breakdown.

boardId
string
cycleId
string
boardBudgetHours
integer<int32>
cycleBudgetHours
integer<int32>
cyclePlannedHours
integer<int32>
resources
object[]
aggregate
object