Tasks
The unit of work. Subtasks are tasks with a parent.
Get Tasks
This endpoint fetch the list of tasks for the team member.
query Parameters
project_idProject ID
task_group_idTask Group ID
task_idTask ID
member_idMember ID
meeting_idMeeting ID
milestone_idMilestone ID
completed_byCompleted By
archivedArchived
include_archivedInclude Archived
completedCompleted
limitPage size. There is no server maximum; keep it at or below 100.
offsetRecord Offset
orderSort field and direction, colon-separated: dueDate:ASC, dueDate:DESC, archivedOn:DESC, completedOn:DESC. When order is set, sort is ignored.
fromStart of the due-date window. Both from and to must be sent for the filter to apply; ISO 8601, UTC.
toEnd of the due-date window. Both from and to must be sent for the filter to apply; ISO 8601, UTC.
archived_fromStart of the archived-on window. Both archived_from and archived_to must be sent for the filter to apply; ISO 8601, UTC.
archived_toEnd of the archived-on window. Both archived_from and archived_to must be sent for the filter to apply; ISO 8601, UTC.
completed_fromStart of the completed-on window. Both completed_from and completed_to must be sent for the filter to apply; ISO 8601, UTC.
completed_toEnd of the completed-on window. Both completed_from and completed_to must be sent for the filter to apply; ISO 8601, UTC.
include_subtasksInclude Subtask
sortSorting order, default is ascending. Ignored when order is present.
Get Tasks › Responses
Success Response
List of all tasks
hasMoreTrue when the page was full (tasks.length === limit); a full final page also reports true — request the next page to confirm.
Create Task
This endpoint creates the task for the team member.
Create Task › Request Body
nameName
task_group_idTask Group ID
descriptionDescription
orderOrder
task_idTask Id. This field is mandatory only when we want to create this task as subtask of other task.
milestone_idMilestone ID
rule_idRule ID
annotation_idAnnotation ID
due_dateDue Date
start_dateStart Date
assigneesList of Assignees
labelsList of labels
meeting_idsList of meeting ID
embed_urlEmbed URL
bannerBanner
Task Field Body
story_pointsStory Points
Task this one is blocked by, referenced by id.
Create Task › Responses
The resource created successfully
idID
nice_idNice ID
nameName
descriptionDescription
orderOrder
created_atCreated Date
created_byCreated By
archivedArchived Flag
completedCompleted Flag
completed_onCompleted Date
completed_byCompleted By
due_dateDue Date
reminderReminder Date
task_groupTask Group
taskTask
projectProject ID
milestoneMilestone
assigneesAssignees
linked_tasksLinked Tasks
subscribersSubscribers
labelsLabels
Attached custom fields
total_subtasksTotal Number of subtasks
completed_subtasksNumber of completed tasks
commentsNumbers of comments
Files
documentsList of Documents
bannerBanner
hiddenhidden
dependencyDependencies
repeat_cronRepeat Cron
repeat_triggerRepeat Trigger
embed_urlEmbedded URL
repeat_tillRepeat Until
ruleRule ID
story_pointsStory Points
related_commitsarchived_onArchived Date
tracked_timeTracked Time
start_dateStart Date
project_archivedProject Archived
meeting_idsMeeting IDs
Remove Tasks (bulk)
Get Personal Tasks
This endpoint fetch the list of personal tasks for the team member.
query Parameters
limitNo of records per page
offsetRecord Offset
meeting_idMeeting ID
completedCompleted?
Get Personal Tasks › Responses
Success Response
List of all tasks
hasMoreTrue when the page was full (tasks.length === limit); a full final page also reports true — request the next page to confirm.
Create Personal Task
This endpoint creates a personal task for the team member.
Create Personal Task › Request Body
limitNo of records per page
offsetRecord Offset
meeting_idMeeting ID
completedCompleted?
Create Personal Task › Responses
The resource created successfully
idTask id.
niceIdPer-creator sequence number for personal tasks; the highest existing value plus one.
nameTask name.
descriptionTask description; Nifty Markdown.
orderRank among the creator's personal tasks. Assigned as the midpoint between neighbours, or 100 for the first task.
personalAlways true on this endpoint — personal tasks belong to no project.
startDateStart date, or null when none was sent (ISO 8601, UTC).
dueDateDue date, or null when none was sent (ISO 8601, UTC).
createdAtCreation timestamp (ISO 8601, UTC).
updatedAtLast modification timestamp (ISO 8601, UTC).
The team member who created the task.
Parent task when the request carried task_id, making this a subtask; null otherwise.
Recurring rule that produced the task when the request carried rule_id; null otherwise.
assigneesAlways empty on the create response — assignees are cleared before the task is returned.
hiddenForRoles the task is hidden from. Always empty for a personal task.
meeting_idsMeeting ids sent on the request, when any.
Get Task
This endpoint fetch the task details for the team member.
path Parameters
task_idEnter task id
Get Task › Responses
Success Response
idID
nice_idNice ID
nameName
descriptionDescription
orderOrder
created_atCreated Date
created_byCreated By
archivedArchived Flag
completedCompleted Flag
completed_onCompleted Date
completed_byCompleted By
due_dateDue Date
reminderReminder Date
task_groupTask Group
taskTask
projectProject ID
milestoneMilestone
assigneesAssignees
linked_tasksLinked Tasks
subscribersSubscribers
labelsLabels
Attached custom fields
total_subtasksTotal Number of subtasks
completed_subtasksNumber of completed tasks
commentsNumbers of comments
Files
documentsList of Documents
bannerBanner
hiddenhidden
dependencyDependencies
repeat_cronRepeat Cron
repeat_triggerRepeat Trigger
embed_urlEmbedded URL
repeat_tillRepeat Until
ruleRule ID
story_pointsStory Points
related_commitsarchived_onArchived Date
tracked_timeTracked Time
start_dateStart Date
project_archivedProject Archived
meeting_idsMeeting IDs
Reorder Task
This endpoint moves the order of the task.
path Parameters
task_idEnter task id
Reorder Task › Request Body
task_orderTask Order
next_taskNext Task
prev_taskPrevious Task
Reorder Task › Responses
The resource created successfully
messageSuccess message
Assign Task
Remove Assignee
Add Labels
Remove Labels
Add Fields
This endpoint adds the custom field to the task.
path Parameters
task_idEnter task id
Add Fields › Request Body
nameCustom field name
typeCustom field type
rolesRoles
field_idfield_id
descriptiondescription
currencyCurrency
tracking_typeTracking Type
cost_per_hourCost per hour
saveSave
associationAssociation
project_idProject ID
Add Fields › Responses
The resource created successfully