Skip to main content

create_cycle

Create a new cycle (sprint/iteration) within a board.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
boardIdstringYesParent board ID. Use get_board_cycle.
namestringYesCycle name.
descriptionstringYesCycle description.
startDateDateTimeNoCycle start date.
finishDateDateTimeNoCycle end date.
budgetHoursintNoBudget in hours for this cycle.

Returns

A CycleDto with the created cycle’s ID, name, dates, budget, and status.

update_cycle

Update cycle details or close it. Closing a cycle automatically approves all time entries for items in the cycle.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
boardIdstringYesParent board ID.
cycleIdstringYesCycle ID to update.
namestringNoNew cycle name.
startDateDateTimeNoNew start date.
finishDateDateTimeNoNew end date.
budgetHoursintNoNew budget in hours.
closedboolNoSet to true to close the cycle. Closing auto-approves all time entries.

Returns

A CycleDto with the updated cycle details.

delete_cycle

Delete a cycle from a board. Requires Manage permission on the board.
Property
Read-onlyNo

Parameters

ParameterTypeRequiredDescription
boardIdstringYesParent board ID. Use get_board_cycle.
cycleIdstringYesCycle ID to delete.

Returns

A confirmation message with the deleted cycle’s name.

get_cycle_stats

Get item count statistics grouped by cycle.
Property
Read-onlyYes

Parameters

None.

Returns

A list of GroupByCountRecord objects, each containing:
FieldDescription
contentCycle name
countNumber of items in the cycle