Task data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | |
project_id | string | No | (reference to TaskProject) |
parent_id | string | No | |
completed_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
status | enum | No | Values: OPENED, IN_PROGRESS, COMPLETED |
notes | string | No | |
due_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
start_at | string (date-time) | No | Scheduled/planned start of the task (distinct from created_at) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | Scheduled/planned end of the task (distinct from due_at and completed_at) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
priority | string | No | |
assigned_user_ids | string[] | No | (reference to HrisEmployee) |
creator_user_id | string | No | The user who created this task (reference to HrisEmployee) |
follower_user_ids | string[] | No | (reference to HrisEmployee) |
group_ids | string[] | No | (reference to HrisGroup) |
tags | string[] | No | |
url | string | No | |
attachment_ids | string[] | No | Array of attachment IDs retrieved from StorageFile.Get endpoint |
metadata | TaskMetadata[] | No | |
metadata[].id | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
metadata[].slug | string | No | |
has_children | boolean | No | |
type | string | No | The task/issue type name (e.g. Jira issue type). |
time_spent | number | No | |
time_spent_unit | string | No | |
progress | number | No | 0-100 |
story_points | number | No |
Are we missing anything? Let us know