CRcraft
Workspaces

GET /workspace/{workspaceId}/capacity

Changed on

Get the capacity limits a workspace plans against, per period per capacity field

The item values say how much work is loaded into a period; this says how much the period can hold. netCapacity is the figure the Capacity Planning view shows.

A capacity field is a NUMBER custom field flagged capacityEnabled in get_workspace_custom_fields, or the built-in storyPoints, which is what most workspaces actually plan against.

Request

  • Base URL
    https://api.craft.io
  • URL
    https://api.craft.io/workspace/{workspaceId}/capacity
  • Auth
    API key in header x-api-key

Path parameters

workspaceIdstring required

Query parameters

periodType'sprint' | 'quarter' | 'timeframe' required

A period a capacity limit can be set against.

timeframe is not a period table: it is an option of a timeframe custom field (H1 2025, Q3'2026), which a workspace can plan against instead of sprints or quarters. Its period id is the option id.

Which periods to read: sprint, quarter, or timeframe (the options of a timeframe custom field).

periodIdsstring

Optional comma-separated period ids. Omit for every period.

capacityFieldIdsstring

Optional comma-separated capacity field ids; storyPoints is accepted.

Response

Capacity limits per period per capacity field

Changes

  • 6009bb084cb5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 9388f8d7ecd8Revision changes
    • info

      endpoint added