Tasks

For more details on how to work with custom fields please refer to Working with custom fields guide.

The Task object represents a task within the project management system.

You can find out more about tasks in our Help documentation: Tasks and task lists

Task can be one of two types:

  • milestone
  • task

Following diagram shows tasks in our data hierarchy:

ProjectBoardTask listTaskCommentsSubtasksTodos

For Task dependencies please refer to TaskDependency endpoint documentation

Attributes

after string
Parameter `filter`

Return tasks created on or after this date.

assignee person
Response

The person assigned to this task.

assignee_id integer
Request Parameter `filter`

Filter by assigned person (also matches open to-do assignees).

assignee_name object
Parameter `sort`

Filter by assigned person (also matches open to-do assignees).

attachment_ids object
Request

Files attached to this task.

attachments array of attachment
Response

Files attached to this task.

before string
Parameter `filter`

Return tasks created on or before this date.

billable_time integer
Response Parameter `filter` Parameter `sort`

Total billable hours tracked on this task (time + correction for billable services, zero for non-billable).

blocking_dependency_count integer
Response

Number of tasks this task is blocking from starting.

board_id integer
Parameter `filter`

Filter by folder (board) ID.

board_name string
Parameter `filter` Parameter `sort`

Filter by folder name (text search).

board_position object
Parameter `sort`

Sort position of this task within its board (folder).

board_status integer
Parameter `filter` Enum

The open/closed status of the task list (board) this task belongs to.

Enum Values (2 values)

  • 1
  • 2
bookable_after string
Parameter `filter`

Filter tasks to those bookable after this date.

bookable_before string
Parameter `filter`

Filter tasks to those bookable before this date.

bookings_count integer
Response

Number of scheduled bookings referencing this task.

closed object
Response

Whether the task is closed (derived from closed_at).

closed_after string
Parameter `filter`

Return tasks closed on or after this date.

closed_at string
Response Parameter `filter` Parameter `sort`

Timestamp when the task was closed, or null if still open.

closed_before string
Parameter `filter`

Return tasks closed on or before this date.

company_id integer
Parameter `filter`

Filter by client company (via the task's project).

company_name object
Parameter `sort`

Filter by client company (via the task's project).

created_at string
Response Parameter `filter` Parameter `sort`

Timestamp when the task was created.

creation_method_id integer
Response Enum

How the task was created (e.g. manually, via automation, via email).

Enum Values (4 values)

  • 1
    Native created
  • 2
    Created through email
  • 3
    Created through integration
  • 4
    Slack
creator person
Response

The person who created this task.

creator_id integer
Parameter `filter`

ID of the person who created this task.

creator_name object
Parameter `sort`

The name of the person who created this task.

custom_field_attachments array of attachment
Response

Files uploaded to file-type custom fields on this task.

custom_field_people array of person
Response

People referenced in person-type custom fields on this task.

custom_fields object
Response Request Parameter `filter` Parameter `sort`

Custom field values set on this task.

date_range string
Parameter `filter`

Filter tasks overlapping a date range (for timeline/Gantt views).

deleted_at string
Response

Timestamp if the task was soft-deleted, null otherwise.

dependency_type integer
Parameter `filter` Enum

Filter by dependency type: blocking, waiting on, or linked.

Enum Values (3 values)

  • 1
  • 2
  • 3
due_date string
Response Request Parameter `filter` Parameter `sort`

Date by which the task should be completed.

due_date_after string
Parameter `filter`

Return tasks due on or after this date.

due_date_before string
Parameter `filter`

Return tasks due on or before this date.

due_date_new string
Parameter `filter`

Return tasks due on this exact date.

due_date_on string
Parameter `filter`

Return tasks due on this exact date.

due_time string
Response Request

Time of day for the due date deadline (HH:MM format).

email_key string
Response

Unique key for creating comments on this task via email.

folder_id integer
Parameter `filter`

Filter by folder ID (alias for board_id).

folder_name string
Parameter `filter` Parameter `sort`

Filter by folder name (alias for board_name).

folder_position object
Parameter `sort`

Sort position of this task within its folder.

folder_status integer
Parameter `filter` Enum

Filter by whether the folder is active or archived (alias for board_status).

Enum Values (2 values)

  • 1
  • 2
full_query string
Parameter `filter`

Full-text search across task fields.

fuzzy_dates string
Parameter `filter`

Fuzzy date matching across task date fields.

fuzzy_people integer
Parameter `filter`

Fuzzy match by people related to the task.

id integer
Parameter `filter` Parameter `sort`

The unique identifier of this task.

initial_estimate integer
Response Request Parameter `filter` Parameter `sort`

Originally forecasted time needed to complete the task, in minutes.

jump_query string
Parameter `filter`

Quick jump search by task name or number.

last_activity string
Parameter `filter` Parameter `sort`

Timestamp of the most recent activity on this task.

last_activity_after string
Parameter `filter`

Return tasks with last activity after this date.

last_activity_at string
Response Parameter `sort`

Timestamp of the most recent activity on this task.

last_activity_before string
Parameter `filter`

Return tasks with last activity before this date.

last_actor person
Response

The last person who made changes to this task.

last_actor_id integer
Parameter `filter`

ID of the person who last performed an activity on this task.

last_actor_name object
Parameter `sort`

The name of the person who last performed an activity on this task.

linked_dependency_count integer
Response

Number of tasks linked to this one (informational, no blocking).

number object
Response Parameter `sort`

Short numeric identifier (alias for task_number).

open_subtask_count integer
Response

Number of unclosed subtasks.

open_todo_count integer
Response

Number of uncompleted to-do items.

organization organization
Response

The organization this task belongs to.

overdue_status integer
Parameter `filter` Enum

Filter by whether the task is overdue (past due date).

Enum Values (2 values)

  • 1
  • 2
Response

The parent task if this is a subtask.

parent_task_id integer
Request Parameter `filter`

Filter by parent task (to find subtasks of a specific task).

person_type integer
Parameter `filter`

Filter by parent/subtask distinction.

placement integer
Response Parameter `sort`

Sort position of this task within its task list.

private boolean
Response Request

Whether this task is visible only to project members (not shared via public links).

project project
Response

The project this task belongs to.

project_id integer
Request Parameter `filter`

ID of the project (workspace) this task belongs to.

project_manager_id integer
Parameter `filter`

Filter by the project's responsible person.

project_name object
Parameter `sort`

The name of the project this task belongs to.

project_type integer
Parameter `filter` Enum

Filter by project type: internal (overhead) or client (billable).

Enum Values (2 values)

  • 1
  • 2
public_access boolean
Parameter `filter`

Filter by task privacy (deprecated — use private filter instead).

query string
Parameter `filter`

Quick search matching task title and number.

query_extended string
Parameter `filter`

Extended search matching title, number, and description.

remaining_time integer
Response Request Parameter `filter` Parameter `sort`

Current projection of time still needed, decreases as time is tracked or can be adjusted manually.

Response

The recurring schedule configuration if this task repeats.

repeating boolean
Parameter `filter`

Whether this task is part of a repeating schedule.

repeat_on_date string
Response Request

Specific date for date-based recurring tasks.

repeat_on_interval integer
Response Request

How frequently the task repeats (e.g. daily, weekly, monthly).

repeat_on_monthday integer
Response Request

Day of the month for monthly recurring tasks.

repeat_on_weekday string
Response Request

Day of the week for weekly recurring tasks.

repeat_origin_id integer
Response

ID of the original task that spawned this recurring instance.

repeat_schedule_id integer
Response Request Enum

ID of the repeat schedule if this task recurs on a regular interval.

Enum Values (5 values)

  • 1
    Daily
  • 2
    Weekly
  • 3
    Monthly
  • 4
    Yearly
  • 5
    Biweekly
service service
Response

The budget service linked to this task for time tracking and billing.

service_id integer
Request Parameter `filter`

ID of the service (billing point) this task is linked to.

skip_reposition boolean
Request

If true, skips reordering of other tasks when placing this one.

start_date string
Response Request Parameter `filter` Parameter `sort`

Date when work on the task is planned to begin.

start_date_after string
Parameter `filter`

Return tasks starting on or after this date.

start_date_before string
Parameter `filter`

Return tasks starting on or before this date.

status integer
Parameter `filter` Enum

Filter by open (1) or closed (2) status.

Enum Values (2 values)

  • 1
  • 2
subscriber_id integer
Parameter `filter`

ID of a person who is subscribed to notifications for this task.

subscriber_ids object
Request

Array of IDs of people subscribed to notifications for this task.

subtask boolean
Parameter `filter`

Whether this task is a subtask of another task.

subtask_count integer
Response

Total number of subtasks under this task.

subtask_placement integer
Response

Sort position among sibling subtasks under the parent task.

tag_list object
Response Request

Tags applied to this task.

tags string
Parameter `filter`

Tags applied to this task.

task_dependency_count integer
Response

Total number of dependency relationships on this task.

task_list task list
Response

The task list this task belongs to within a folder.

task_list_id integer
Request Parameter `filter`

ID of the task list (milestone) this task belongs to.

task_list_name string
Parameter `filter` Parameter `sort`

Filter by task list name (text search).

task_list_position object
Parameter `sort`

Sort position of this task within its task list.

task_list_status integer
Parameter `filter` Enum

The open/closed status of the task list this task belongs to.

Enum Values (2 values)

  • 1
  • 2
task_number string
Response Parameter `filter` Parameter `sort`

Unique number identifying a task within the organization.

task_type integer
Parameter `filter` Enum

Filter by parent/subtask distinction.

Enum Values (2 values)

  • 1
  • 2
template string
Parameter `filter`

Return only template tasks.

template_id integer
Parameter `filter`

ID of the template this task was created from.

template_object template
Response

The template this task was created from, if applicable.

title string
Response Request Parameter `filter` Parameter `sort`

Descriptive name of the task.

todo_assignee_ids object
Response

IDs of people assigned to open to-do items on this task.

todo_count integer
Response

Total number of to-do checklist items on this task.

trackable_by_person_id integer
Parameter `filter`

Filter tasks to those trackable by the specified person, based on restricted tracking settings.

type_id integer
Response Request Parameter `filter` Enum

Task type: regular task, subtask, or milestone.

Enum Values (2 values)

  • 1
    Task
  • 3
    Milestone
updated_at string
Response Parameter `filter` Parameter `sort`

Timestamp when the task was last modified.

waiting_on_dependency_count integer
Response

Number of tasks this task is waiting on before it can proceed.

worked_time integer
Response Parameter `filter` Parameter `sort`

Total time tracked on this task across all time entries, in minutes.

workflow_id integer
Parameter `filter`

ID of the workflow this task's status belongs to.

workflow_status workflow status
Response

Current workflow status of this task (e.g. 'To Do', 'In Progress', 'Done').

workflow_status_category_id integer
Parameter `filter` Enum

Filter by status category: not started (1), started (2), or closed (3).

Enum Values (3 values)

  • 1
  • 2
  • 3
workflow_status_id integer
Request Parameter `filter`

ID of the workflow status currently assigned to this task.

workflow_status_name object
Parameter `sort`

Current workflow status of this task (e.g. 'To Do', 'In Progress', 'Done').

workflow_status_position object
Parameter `sort`

Sort position of the workflow status within its workflow.