Card types
A type of cards, such as Task or Bug, with its own color and fields. Cards of the type show the first letter of its name. Give one record per type; cards refer to it with type_ref, and a board may choose one as its default. A type with the same name already in the company is reused and keeps its own field settings; when card_properties differ from them, the import reports those entries as not applied. Names are distinct without regard to case.
Files in the package
List every file of this entity in resource_files of the manifest, with "resource": "card_types". An entity can have any number of files. See Bundle format.
[
{
"resource": "card_types",
"path": "resources/card_types.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. |
name | string | Yes | Name of the type, for example Metric. Up to 128 characters; names are distinct without regard to case.Constraints: 1–128 characters. Rule: Unique without regard to case. |
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. |
card_properties | object[] refers to Custom properties | No | Works like an empty form for cards of this type: the fields listed here appear on every such card from the start, in this order, even before anyone fills them in. Nothing is pre-filled, and a card can still get other fields. Each item is one of your custom properties, {"property_ref": "cp-priority"}, or a standard card field, {"field": "due_date"}; add "required": true if it must be filled in (for a standard field that is its only effect). An existing card type that is reused keeps its own list, and the items that differ are reported. |
card_properties[].field | enum | Depends on the variant | A built-in card field of the entry. Constraints: one of size, due_date, tags, timeline, description. |
card_properties[].property_ref | Ref<custom_properties> refers to Custom properties | Depends on the variant | A custom property of the entry. Constraints: 1–512 characters. |
card_properties[].required | boolean | No | Whether the field must be filled; the default is false. |
color | #RRGGBB? | No | Type color. It is replaced with the nearest color of the card type palette; an omitted color gets a default one. Constraints: the nearest color of the target palette is used. |
References
Referenced by
- Boards:
default_card_type_ref - Card history:
snapshot.type_ref - Cards:
type_ref
Card types
Refers to
author_ref→ Userscard_properties[].property_ref→ Custom properties
Show on the entity map
Example
A record of this entity:
{
"external_id": "ct-metric",
"name": "Metric",
"color": "#1976d2",
"card_properties": [
{
"field": "description"
},
{
"property_ref": "cp-target",
"required": true
},
{
"property_ref": "cp-priority"
}
],
"author_ref": "u-ava"
}Rules
- The value of name must be unique without regard to case.
Related entities
Boards, Cards
Check after the import
After the import, the records of this entity can be checked on Card types › Get list of card types.
JSON Schema
card_types.json
