Cards data
Fields:
| Field Name | Type | Required | Description |
|---|---|---|---|
| id | string, number | Yes | Unique identifier of card. |
| column_id | string, number | Yes | Unique identifier of column in board. |
| type_name | string, null | No | Type name of card. |
| title | string | Yes | Title of card. |
| archived | boolean | No | Archived status of card. |
| blocked_by_card_ids | array | null | No | IDs of cards which are blocking current card. |
| blocks_card_ids | array | null | No | IDs of cards which are blocked because of current card. |
| related_card_ids | array | null | No | IDs of cards which are related to current card. |
| checklists | CardChecklist[] | No | The checklists of card. |
| child_card_ids | array | null | No | IDs of child cards. |
| created | string | null | No | Date of creation of card. |
| description | string | null | No | The description content of card. |
| description_type | string | null | No | Defines the type of description. |
| due_date | CardDateObject | No | Due date of card. |
| asap | boolean | No | ASAP marker |
| size_text | string | null | No | Card size. |
| estimate_workload | number | null | No | Estimated time. |
| history | CardHistory[] | No | Defines the card actions history. |
| links | CardLinks[] | No | Defines the links attached to card. |
| member_ids | array | null | No | IDs of card members. |
| owner_id | string, number, null | No | Unique identifier of owner of card. |
| parent_card_ids | array | null | No | IDs of parent cards. |
| planned_end | CardDateObject | No | Planned end date of card. |
| planned_start | CardDateObject | No | Planned start date of card. |
| planned_predecessors | CardPlannedPredecessor[] | No | Planned predecessors cards. |
| properties | CardProperties[] | No | Array of custom properties of card. |
| responsible_id | string, number, null | No | Unique identifier of responsible of card. |
| tags | CardTags[] | No | Defines the tags of card. |
| key | string | null | No | Unique key identifier for the card. |
Description of fields:
id:
A unique identifier of card, which is used to map and track the card within our system.
column_id:
Unique identifier of column within which the card is placed.
type_name:
Type name of card.
title:
The complete title of card, used for display purposes.
archived:
Indicates whether the card is archived. When set to true, the card will be hidden from the user interface.
blocked_by_card_ids:
Array of card ids which are blocking the current card.
blocks_card_ids:
Array of card ids which are blocked because of current card.
related_card_ids:
Array of card ids which are related to current card.
checklists:
The checklists of card.
child_card_ids:
Array of child card ids.
created:
Date of creation of card.
description:
The content description of card. It's possible to create cross-links to documents and cards: for Markdown links have to be like /[.*?](((?:card|document)/[a-zA-Z0-9-]+))/, for HTML – /href="((?:card|document)/[a-zA-Z0-9-]+)"/, where [a-zA-Z0-9-]+ is document or card ID. Examples: [cardTitle](card/ca3d1d44-1b1b-4b1b-8b1b-ca3d1dca3d1dca), href="document/D0C1D222-1B1B-4B1B-8B1B-D0C1DD0C1DD0".
description_type:
The type of description, available values are markdown and html. If not explicitly provided, the system defaults to using the 'markdown' format.
due_date:
Due date of card
asap:
ASAP marker
size_text:
Card size. Example of acceptable values: '1', '23.45', '.5', 'S', '3 M', 'L', 'XL', etc...
estimate_workload:
Estimated duration (in hours, e.g., 2.5).
history:
Array of card actions history.
links:
Array of links that are attached to card.
member_ids:
Array of card member user IDs.
owner_id:
Unique identifier of owner of card, used to create relations and display purposes.
parent_card_ids:
Array of parent card ids.
planned_end:
Planned end date of card, used for display purposes, visible in Timeline section.
planned_start:
Planned start date of card, used for display purposes, visible in Timeline section.
planned_predecessors:
Planned predecessors cards, used for planned relation, visible in Timeline section. Fields planned_start and planned_end are required for both cards
properties:
Array of custom properties available for current card.
responsible_id:
Unique identifier of responsible for card, used to create relations, also used for display purposes.
tags:
Array of tags that are attached to card.
key:
A unique key for the card in format prefix-number, where prefix is inherited from the card's tree entity (space or folder) and number is the sequential card number within that entity. For the key to be set: 1) the corresponding entity in the import must also have a key; 2) the corresponding entity with a key has been created in the current import; 3) the entity key and the prefix part of the card key must match.
CardChecklist:
| Field Name | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Name of checklist. |
| items | array | Yes | Array of checklist items. |
CardChecklistItem:
| Field Name | Type | Required | Description |
|---|---|---|---|
| text | string | Yes | Text description of checklist item. |
| checked | boolean, null | No | If true checklist is marked as done. |
| checked_at | string, null | No | DateTime when checklist item was checked. |
| checked_by | string, number, null | No | ID of user who checked the checklist item. |
| created | string | null | No | DateTime of creation checklist item. |
| created_by | string, number, null | No | ID of user who created the checklist item. |
| due_date | object | null | No | Due date of checklist item. |
| responsible_id | string, number, null | No | ID of user who is responsible for checklist item. |
| sort_order | number, null | No | Order of checklist item in checklist. |
CardDateObject:
| Field Name | Type | Required | Description |
|---|---|---|---|
| value | string | Yes | Date value. |
| time_present | boolean, null | No | Boolean value that defines if `value` contains only date or time also. |
CardHistory:
| Field Name | Type | Required | Description |
|---|---|---|---|
| type | string | Yes | Type of history action. |
| created | string | Yes | DateTime of history action. |
| new_value | object | Yes | Object containing column ID. |
| old_value | object | Yes | Object containing column ID. |
| author_id | string, number, null | No | ID of author of action. |
CardLinks:
| Field Name | Type | Required | Description |
|---|---|---|---|
| url | string, number | Yes | The URL of resource that should be displayed. |
| created | string | null | No | DateTime of adding card link. |
| description | string | null | No | String description of card link. |
CardProperties:
| Field Name | Type | Required | Description |
|---|---|---|---|
| id | string, number | Yes | Unique identifier of custom property. |
| value | boolean | string, number | string | string | array | array | array | array | Yes | Custom property values. |
CardTags:
| Field Name | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Name of card tag. |
CardPlannedPredecessor:
| Field Name | Type | Required | Description |
|---|---|---|---|
| id | string, number | Yes | Planned predecessor card id |
| gap | integer | No | Planned predecessor relation offset |
| gap_type | string | No | Planned predecessor relation offset type |
JSON schema:
