Task data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNo
project_idstringNo(reference to TaskProject)
parent_idstringNo
completed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
statusenumNoValues: OPENED, IN_PROGRESS, COMPLETED
notesstringNo
due_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
start_atstring (date-time)NoScheduled/planned start of the task (distinct from created_at) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)NoScheduled/planned end of the task (distinct from due_at and completed_at) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
prioritystringNo
assigned_user_idsstring[]No(reference to HrisEmployee)
creator_user_idstringNoThe user who created this task (reference to HrisEmployee)
follower_user_idsstring[]No(reference to HrisEmployee)
group_idsstring[]No(reference to HrisGroup)
tagsstring[]No
urlstringNo
attachment_idsstring[]NoArray of attachment IDs retrieved from StorageFile.Get endpoint
metadataTaskMetadata[]No
metadata[].idstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo
metadata[].slugstringNo
has_childrenbooleanNo
typestringNoThe task/issue type name (e.g. Jira issue type).
time_spentnumberNo
time_spent_unitstringNo
progressnumberNo0-100
story_pointsnumberNo

TypeScript

TypeScript
export type TaskTask = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string;
	project_id?: string; // (reference to TaskProject)
	parent_id?: string;
	completed_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	status?: 'OPENED' | 'IN_PROGRESS' | 'COMPLETED';
	notes?: string;
	due_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	start_at?: string-time; // Scheduled/planned start of the task (distinct from created_at) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // Scheduled/planned end of the task (distinct from due_at and completed_at) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	priority?: string;
	assigned_user_ids?: string[]; // (reference to HrisEmployee)
	creator_user_id?: string; // The user who created this task (reference to HrisEmployee)
	follower_user_ids?: string[]; // (reference to HrisEmployee)
	group_ids?: string[]; // (reference to HrisGroup)
	tags?: string[];
	url?: string;
	attachment_ids?: string[]; // Array of attachment IDs retrieved from StorageFile.Get endpoint
	metadata?: [];
	has_children?: boolean;
	type?: string; // The task/issue type name (e.g. Jira issue type).
	time_spent?: number;
	time_spent_unit?: string;
	progress?: number; // 0-100
	story_points?: number;
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodTaskTask = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional(),
	project_id: z.string().optional().describe("(reference to TaskProject)"),
	parent_id: z.string().optional(),
	completed_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	status: z.enum("OPENED", "IN_PROGRESS", "COMPLETED").optional(),
	notes: z.string().optional(),
	due_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	start_at: z.string-time().optional().describe("Scheduled/planned start of the task (distinct from created_at) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("Scheduled/planned end of the task (distinct from due_at and completed_at) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	priority: z.string().optional(),
	assigned_user_ids: z.array().optional().describe("(reference to HrisEmployee)"),
	creator_user_id: z.string().optional().describe("The user who created this task (reference to HrisEmployee)"),
	follower_user_ids: z.array().optional().describe("(reference to HrisEmployee)"),
	group_ids: z.array().optional().describe("(reference to HrisGroup)"),
	tags: z.array().optional(),
	url: z.string().optional(),
	attachment_ids: z.array().optional().describe("Array of attachment IDs retrieved from StorageFile.Get endpoint"),
	metadata: z.array().optional(),
	has_children: z.boolean().optional(),
	type: z.string().optional().describe("The task/issue type name (e.g. Jira issue type)."),
	time_spent: z.number().optional(),
	time_spent_unit: z.string().optional(),
	progress: z.number().optional().describe("0-100"),
	story_points: z.number().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class TaskTaskStatus(str, Enum):
	OPENED = 'OPENED'
	IN_PROGRESS = 'IN_PROGRESS'
	COMPLETED = 'COMPLETED'

@dataclasses.dataclass
class TaskTask:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	name: Optional[str]
	"""(reference to TaskProject)"""
	project_id: Optional[str]
	parent_id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	completed_at: Optional[str]
	status: Optional[TaskTaskStatus]
	notes: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	due_at: Optional[str]
	"""Scheduled/planned start of the task (distinct from created_at) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""Scheduled/planned end of the task (distinct from due_at and completed_at) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	priority: Optional[str]
	"""(reference to HrisEmployee)"""
	assigned_user_ids: Optional[List[List[str]]]
	"""The user who created this task (reference to HrisEmployee)"""
	creator_user_id: Optional[str]
	"""(reference to HrisEmployee)"""
	follower_user_ids: Optional[List[List[str]]]
	"""(reference to HrisGroup)"""
	group_ids: Optional[List[List[str]]]
	tags: Optional[List[List[str]]]
	url: Optional[str]
	"""Array of attachment IDs retrieved from StorageFile.Get endpoint"""
	attachment_ids: Optional[List[List[str]]]
	metadata: Optional[PropertyTaskTaskMetadata]
	has_children: Optional[bool]
	"""The task/issue type name (e.g. Jira issue type)."""
	type: Optional[str]
	time_spent: Optional[int]
	time_spent_unit: Optional[str]
	"""0-100"""
	progress: Optional[int]
	story_points: Optional[int]
Are we missing anything? Let us know
Was this page helpful?