Task lists help you organize and track work within an administration. They contain groups of tasks that can be assigned to users and tracked for completion.
Returns information about a task list group
Returns information about a task list group, including its tasks.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Returns information about a task list group › Responses
A task list group
id^\d+$A unique record identifier
namerow_orderreport_typecreated_atupdated_atDeletes a task list group
Permanently deletes a task list group and all its tasks.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Deletes a task list group › Responses
Group deleted
Updates a task list group
Updates a task list group's name or report type. Updating the report type will destroy all tasks and generate new tasks based on the new report.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Updates a task list group › Responses
Group updated
id^\d+$A unique record identifier
namerow_orderreport_typecreated_atupdated_atCreates a new task in a group
Creates a new task in the specified task list group.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
task_list_group_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Creates a new task in a group › Responses
Task created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
namedescriptionrow_ordercompleted_atreport_typetask_lists_group_id^\d+$A unique record identifier
parent_task_id^\d+$A unique record identifier
assignee_id^\d+$A unique record identifier
created_atupdated_atsubtaskstask_list_task_response (circular)Returns information about a task
Returns information about a task, including its subtasks, notes, and events.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Returns information about a task › Responses
A task
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
namedescriptionrow_ordercompleted_atreport_typetask_lists_group_id^\d+$A unique record identifier
parent_task_id^\d+$A unique record identifier
assignee_id^\d+$A unique record identifier
created_atupdated_atsubtaskstask_list_task_response (circular)Deletes a task
Permanently deletes a task and all its subtasks. Generated tasks cannot be deleted.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Deletes a task › Responses
Task deleted
Updates a task
Updates a task's attributes.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Updates a task › Responses
Task updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
namedescriptionrow_ordercompleted_atreport_typetask_lists_group_id^\d+$A unique record identifier
parent_task_id^\d+$A unique record identifier
assignee_id^\d+$A unique record identifier
created_atupdated_atsubtaskstask_list_task_response (circular)Assigns a user to a task
Assigns a user to the specified task.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
task_list_task_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Assigns a user to a task › Request Body
assignee_id^\d+$ · requiredThe ID of the user to assign to the task. A user must have permissions to a task or else a 404 will be thrown.
Assigns a user to a task › Responses
User assigned to task
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
namedescriptionrow_ordercompleted_atreport_typetask_lists_group_id^\d+$A unique record identifier
parent_task_id^\d+$A unique record identifier
assignee_id^\d+$A unique record identifier
created_atupdated_atsubtaskstask_list_task_response (circular)Unassigns the user from a task
Removes the current assignment from the specified task.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
task_list_task_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Unassigns the user from a task › Responses
User unassigned from task
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
namedescriptionrow_ordercompleted_atreport_typetask_lists_group_id^\d+$A unique record identifier
parent_task_id^\d+$A unique record identifier
assignee_id^\d+$A unique record identifier
created_atupdated_atsubtaskstask_list_task_response (circular)Completes a task
Marks a task and all its subtasks as completed.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
task_list_task_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Completes a task › Responses
Task completed
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
namedescriptionrow_ordercompleted_atreport_typetask_lists_group_id^\d+$A unique record identifier
parent_task_id^\d+$A unique record identifier
assignee_id^\d+$A unique record identifier
created_atupdated_atsubtaskstask_list_task_response (circular)Reopens a task
Reopens a completed task and possible parent tasks.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
task_list_task_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Reopens a task › Responses
Task reopened
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
namedescriptionrow_ordercompleted_atreport_typetask_lists_group_id^\d+$A unique record identifier
parent_task_id^\d+$A unique record identifier
assignee_id^\d+$A unique record identifier
created_atupdated_atsubtaskstask_list_task_response (circular)Creates a note on a task
Creates a new note on the specified task.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
task_list_task_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Creates a note on a task › Responses
Note created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
entity_id^\d+$A unique record identifier
entity_typeuser_id^\d+$A unique record identifier
assignee_id^\d+$A unique record identifier
todonotecompleted_atcompleted_by_id^\d+$A unique record identifier
todo_typedatacreated_atupdated_atCreates a task list from a template
Creates a new task list based on the specified template.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
task_list_template_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Creates a task list from a template › Responses
Task list created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
namedescriptiondeadline_onperiod_beginperiod_endcompletedtemplate_id^\d+$A unique record identifier
total_tasks_countcompleted_tasks_countcreated_atupdated_atReturns information about a task list
Returns information about a task list, including its groups, tasks, and subtasks.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Returns information about a task list › Responses
A task list
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
namedescriptiondeadline_onperiod_beginperiod_endcompletedtemplate_id^\d+$A unique record identifier
total_tasks_countcompleted_tasks_countcreated_atupdated_atDeletes a task list
Permanently deletes a task list and all its groups and tasks.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Deletes a task list › Responses
Task list deleted
Updates a task list
Updates a task list's name, description, or deadline.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Updates a task list › Responses
Task list updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
namedescriptiondeadline_onperiod_beginperiod_endcompletedtemplate_id^\d+$A unique record identifier
total_tasks_countcompleted_tasks_countcreated_atupdated_atCreates a new group in a task list
Creates a new group in the specified task list.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
task_list_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Creates a new group in a task list › Responses
Group created
id^\d+$A unique record identifier
namerow_orderreport_typecreated_atupdated_atList all task lists of an administration
Returns a paginated list of task lists in the administration. Each page contains 30 task lists by default. Use the page parameter to fetch the next page.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
per_page^\d+$Amount of task lists per page, default: 30
pageThe page to fetch, starting at 1.
List all task lists of an administration › Responses
A list of task lists
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
namedescriptiondeadline_onperiod_beginperiod_endcompletedtemplate_id^\d+$A unique record identifier
total_tasks_countcompleted_tasks_countcreated_atupdated_atCreates a new task list
Creates a new task list. Optionally, you can provide a template_id to create the task list from a template.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Creates a new task list › Responses
Task list created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
namedescriptiondeadline_onperiod_beginperiod_endcompletedtemplate_id^\d+$A unique record identifier
total_tasks_countcompleted_tasks_countcreated_atupdated_at