Checklist items
One item of a checklist, such as "Write the definition", that can be checked off. Items belong to a checklist from checklists. The items of a checklist keep the order of their records. Check data (checked_at, checker_ref) is allowed only for a checked item.
A record of this entity needs records of other entities in the package: Checklists.
Files in the package
List every file of this entity in resource_files of the manifest, with "resource": "checklist_items". An entity can have any number of files. See Bundle format.
[
{
"resource": "checklist_items",
"path": "resources/checklist_items.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. |
checklist_ref | Ref<checklists> refers to Checklists | Yes | The checklist the item belongs to. Give the external_id of a checklists record. |
text | string | Yes | The item's text, for example Write the definition.Constraints: at least 1 character. |
author_ref | Ref<users>? refers to Users | No | The user who added the item to the checklist. Give the external_id of a users record. |
checked | boolean | No | Whether the item is done. Default: |
checked_at | Timestamp? | No | When the item was checked off. Allowed only when checked is true.Constraints: RFC 3339 with a time zone. Rule: Only when checked is true. |
checker_ref | Ref<users>? refers to Users | No | The user who checked the item off. Allowed only when checked is true. Give the external_id of a users record.Rule: Only when checked is true. |
due_date | LocalDate? | No | The day the item is due, as a plain YYYY-MM-DD string, for example "2026-03-31". Unlike the card's due_date, it is not an object and has no time. The year must be between 2000 and 2999.Constraints: YYYY-MM-DD; year 2000 to 2999. |
responsible_ref | Ref<users>? refers to Users | No | The user responsible for the item. Give the external_id of a users record. |
References
Refers to
author_ref→ Userschecker_ref→ Userschecklist_ref→ Checklistsresponsible_ref→ Users
Show on the entity map
Example
A record of this entity:
{
"external_id": "cli-def-1",
"checklist_ref": "cl-definition",
"text": "Write the definition",
"checked": true,
"checked_at": "2026-01-13T10:00:00Z",
"checker_ref": "u-ava",
"responsible_ref": "u-ava"
}Rules
- checked_at and checker_ref only when checked is true.
Related entities
Checklists, Users
Check after the import
After the import, the records of this entity can be checked on Card checklists › Retrieve card checklist.
JSON Schema
checklist_items.json
