Iterations
An iteration (sprint) of a space, such as "Sprint 1", with a goal and dates. The iterations of a space keep the order of their records. Its cards are iteration_cards. status is planned, active or closed; a closed iteration can also have actual_finish_date. A planned iteration may have no dates; an active or closed one needs start_date and finish_date, a closed one also actual_finish_date. finish_date and actual_finish_date must be later than start_date.
A record of this entity needs records of other entities in the package: Spaces.
Files in the package
List every file of this entity in resource_files of the manifest, with "resource": "iterations". An entity can have any number of files. See Bundle format.
[
{
"resource": "iterations",
"path": "resources/iterations.json"
}
]Fields
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string (ExternalId) | Yes | Your own identifier of the record, for example k-mrr, unique within the resource across all of its files and case sensitive. Other records refer to this one by it.Constraints: 1–512 characters. |
space_ref | Ref<spaces> refers to Spaces | Yes | The space the iteration belongs to. Give the external_id of a spaces record. |
title | string | Yes | Name of the iteration, for example Sprint 1. Up to 256 characters.Constraints: 1–256 characters. |
actual_finish_date | Timestamp? | When status is closed | When a closed iteration really finished; later than start_date. Required for a closed iteration, and needs start_date and finish_date.Constraints: RFC 3339 with a time zone. Rule: Later than start_date. |
finish_date | Timestamp? | When status is active or closed | When the iteration is planned to finish; later than start_date. Required for an active or closed iteration.Constraints: RFC 3339 with a time zone. Rule: Later than start_date. |
start_date | Timestamp? | When status is active or closed | When the iteration starts, for example 2026-01-12T09:00:00Z. Required for an active or closed iteration.Constraints: RFC 3339 with a time zone. |
author_ref | Ref<users>? refers to Users | No | The user who created the record, by the external_id of a users record, for example u-ava. Leave it out or use null when the author is unknown or has left. |
created_at | Timestamp | No | When the record was created, with a time zone, for example 2026-01-12T09:30:00Z.Constraints: RFC 3339 with a time zone. Default: |
goal | string? | No | What the iteration is meant to achieve, in a sentence or two. |
status | enum | No | Stage of the iteration: planned (the default), active or closed.Constraints: one of planned, active, closed. Default: |
updated_by_ref | Ref<users>? refers to Users | No | The user who made the last change, by the external_id of a users record. Leave it out or use null when unknown. |
References
Referenced by
- Iteration cards:
iteration_ref
Iterations
Show on the entity map
Example
A record of this entity:
{
"external_id": "it-1",
"space_ref": "s-kpi",
"title": "Sprint 1",
"goal": "Define and publish the revenue metrics.",
"status": "closed",
"start_date": "2026-01-12T09:00:00Z",
"finish_date": "2026-01-26T18:00:00Z",
"actual_finish_date": "2026-01-27T10:00:00Z",
"author_ref": "u-ava",
"created_at": "2026-01-10T09:00:00Z"
}Rules
- an active or closed iteration has start_date and finish_date.
- a closed iteration has actual_finish_date.
- actual_finish_date only with start_date and finish_date.
Related entities
Iteration cards, Spaces
Check after the import
After the import, the records of this entity can be checked on Iterations › Retrieve list of iterations.
JSON Schema
iterations.json
