API Documentation

API Endpoint

Tasks

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:

Task diagram

For Task dependencies please refer to TaskDependency endpoint documentation

Supported filter params

  • after

  • assignee_id (array)

  • before

  • billable_time

  • board_id (array)

  • board_name

  • board_status (1: active, 2: archived)

  • closed_after

  • closed_at

  • closed_before

  • company_id (array)

  • created_at

  • creator_id (array)

  • custom_fields

  • date_range

  • dependency_type

  • description

  • due_date (1: any, 2: overdue)

  • due_date_after

  • due_date_before

  • due_date_on

  • id

  • initial_estimate

  • last_actor_id

  • last_activity

  • last_activity_after

  • last_activity_before

  • overdue_status (1: not overdue, 2: overdue)

  • parent_task_id (array)

  • person_type (1: user, 2: contact, 3: placeholder)

  • project_id (array)

  • project_manager_id (array)

  • project_type (1: internal project, 2 :client project)

  • public_access

  • query

  • remaining_time

  • repeating

  • start_date

  • start_date_after

  • start_date_before

  • status (1: open, 2: closed)

  • subscriber_id (array)

  • tags

  • task_list_id (array)

  • task_list_name

  • task_list_status (1: open, 2: closed)

  • task_number

  • task_type (1: parent task, 2: subtask)

  • title

  • updated_at

  • worked_time

  • workflow_id (array)

  • workflow_status_category_id (1: not started, 2: started, 3: closed)

  • workflow_status_id (array)

Filter operations are supported on this endpoint.

Supported sort params

  • assignee_name

  • billable_time

  • board_name

  • board_position

  • closed_at

  • company_name

  • created_at

  • creator_name

  • custom_fields

  • due_date - sorts due_date and then due_time

  • placement

  • id

  • initial_estimate

  • last_activity

  • last_activity_at

  • last_actor_name

  • number

  • project_name

  • remaining_time

  • start_date

  • task_list_name

  • task_list_position

  • task_number

  • title

  • updated_at

  • worked_time

  • workflow_status_name

  • workflow_status_position

GET /api/v2/tasks
Requestsreturns tasksreturns tags as tag_list

GET  /api/v2/tasks?filter[project_id]=1911

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "347",
      "type": "tasks",
      "attributes": {
        "title": "Ticket title",
        "description": null,
        "number": "1",
        "task_number": "1",
        "private": false,
        "due_date": null,
        "start_date": null,
        "closed_at": null,
        "created_at": "2025-08-12T06:18:14.246+02:00",
        "updated_at": "2025-08-12T06:18:14.246+02:00",
        "repeat_schedule_id": null,
        "repeat_on_interval": null,
        "repeat_on_monthday": null,
        "repeat_on_weekday": [],
        "repeat_on_date": null,
        "repeat_origin_id": null,
        "email_key": "0cc22bd2c9a4c7eb677aeaf868d37a2e",
        "custom_fields": null,
        "todo_count": null,
        "open_todo_count": null,
        "subtask_count": null,
        "open_subtask_count": null,
        "creation_method_id": 1,
        "todo_assignee_ids": [],
        "task_dependency_count": 0,
        "type_id": 1,
        "blocking_dependency_count": 0,
        "waiting_on_dependency_count": 0,
        "linked_dependency_count": 0,
        "placement": null,
        "subtask_placement": null,
        "closed": false,
        "due_time": null,
        "tag_list": [],
        "last_activity_at": "2025-08-12T06:18:14.000+02:00",
        "initial_estimate": null,
        "remaining_time": null,
        "billable_time": null,
        "worked_time": null,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1967"
          }
        },
        "project": {
          "meta": {
            "included": false
          }
        },
        "creator": {
          "meta": {
            "included": false
          }
        },
        "assignee": {
          "meta": {
            "included": false
          }
        },
        "last_actor": {
          "meta": {
            "included": false
          }
        },
        "task_list": {
          "meta": {
            "included": false
          }
        },
        "parent_task": {
          "meta": {
            "included": false
          }
        },
        "workflow_status": {
          "meta": {
            "included": false
          }
        },
        "repeated_task": {
          "meta": {
            "included": false
          }
        },
        "attachments": {
          "meta": {
            "included": false
          }
        },
        "custom_field_people": {
          "meta": {
            "included": false
          }
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/tasks?filter%5Bproject_id%5D=1911&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/tasks?filter%5Bproject_id%5D=1911&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

GET  /api/v2/tasks?filter[project_id]=1948

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "360",
      "type": "tasks",
      "attributes": {
        "title": "Ticket title",
        "description": null,
        "number": "1",
        "task_number": "1",
        "private": false,
        "due_date": null,
        "start_date": null,
        "closed_at": null,
        "created_at": "2025-08-12T06:18:16.942+02:00",
        "updated_at": "2025-08-12T06:18:16.942+02:00",
        "repeat_schedule_id": null,
        "repeat_on_interval": null,
        "repeat_on_monthday": null,
        "repeat_on_weekday": [],
        "repeat_on_date": null,
        "repeat_origin_id": null,
        "email_key": "e9002706682e9a0554bfe7438491e90a",
        "custom_fields": null,
        "todo_count": null,
        "open_todo_count": null,
        "subtask_count": null,
        "open_subtask_count": null,
        "creation_method_id": 1,
        "todo_assignee_ids": [],
        "task_dependency_count": 0,
        "type_id": 1,
        "blocking_dependency_count": 0,
        "waiting_on_dependency_count": 0,
        "linked_dependency_count": 0,
        "placement": null,
        "subtask_placement": null,
        "closed": false,
        "due_time": null,
        "tag_list": [],
        "last_activity_at": "2025-08-12T06:18:16.000+02:00",
        "initial_estimate": null,
        "remaining_time": null,
        "billable_time": null,
        "worked_time": null,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1972"
          }
        },
        "project": {
          "meta": {
            "included": false
          }
        },
        "creator": {
          "meta": {
            "included": false
          }
        },
        "assignee": {
          "meta": {
            "included": false
          }
        },
        "last_actor": {
          "meta": {
            "included": false
          }
        },
        "task_list": {
          "meta": {
            "included": false
          }
        },
        "parent_task": {
          "meta": {
            "included": false
          }
        },
        "workflow_status": {
          "meta": {
            "included": false
          }
        },
        "repeated_task": {
          "meta": {
            "included": false
          }
        },
        "attachments": {
          "meta": {
            "included": false
          }
        },
        "custom_field_people": {
          "meta": {
            "included": false
          }
        },
        "custom_field_attachments": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/tasks?filter%5Bproject_id%5D=1948&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/tasks?filter%5Bproject_id%5D=1948&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

Get tasks
GET/api/v2/tasks

GET /api/v2/tasks/1
Requestsreturns task

GET  /api/v2/tasks/363

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "363",
    "type": "tasks",
    "attributes": {
      "title": "Ticket title",
      "description": null,
      "number": "1",
      "task_number": "1",
      "private": false,
      "due_date": null,
      "start_date": null,
      "closed_at": null,
      "created_at": "2025-08-12T06:18:17.413+02:00",
      "updated_at": "2025-08-12T06:18:17.413+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "55bc8d547410c105739bc3a0ccf651d1",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": [],
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:17.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1974"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Gets a task
GET/api/v2/tasks/{id}

URI Parameters
HideShow
id
number (required) Example: 1

task id

POST /api/v2/tasks
Requestscreates taskcreates task with default statuscreates taskreturns errorcreates task

POST  /api/v2/tasks

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "test name",
      "initial_estimate": 60,
      "remaining_time": 60,
      "start_date": "2019-05-05",
      "due_date": "2019-05-06"
    },
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "1957"
        }
      },
      "task_list": {
        "data": {
          "type": "task_lists",
          "id": "376"
        }
      },
      "workflow_status": {
        "data": {
          "type": "workflow_statuses",
          "id": "2594"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "366",
    "type": "tasks",
    "attributes": {
      "title": "test name",
      "description": null,
      "number": "2",
      "task_number": "2",
      "private": false,
      "due_date": "2019-05-06",
      "start_date": "2019-05-05",
      "closed_at": "2025-08-12T06:18:17.000+02:00",
      "created_at": "2025-08-12T06:18:17.970+02:00",
      "updated_at": "2025-08-12T06:18:17.970+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "81c9a3ba298bfd1f4aa9f69b586df4b7",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": null,
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": true,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:17.000+02:00",
      "initial_estimate": 60,
      "remaining_time": 60,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1976"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/tasks

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "test name",
      "initial_estimate": 60,
      "remaining_time": 60,
      "start_date": "2019-05-05",
      "due_date": "2019-05-06"
    },
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "1959"
        }
      },
      "task_list": {
        "data": {
          "type": "task_lists",
          "id": "378"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "370",
    "type": "tasks",
    "attributes": {
      "title": "test name",
      "description": null,
      "number": "2",
      "task_number": "2",
      "private": false,
      "due_date": "2019-05-06",
      "start_date": "2019-05-05",
      "closed_at": null,
      "created_at": "2025-08-12T06:18:18.622+02:00",
      "updated_at": "2025-08-12T06:18:18.622+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "96e2d8d6b5e1c519992cff02a2d45a4d",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": null,
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:18.000+02:00",
      "initial_estimate": 60,
      "remaining_time": 60,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1978"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/tasks

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "test name",
      "initial_estimate": 60,
      "remaining_time": 60,
      "start_date": "2019-05-05",
      "due_date": "2019-05-06",
      "private": true
    },
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "1960"
        }
      },
      "task_list": {
        "data": {
          "type": "task_lists",
          "id": "379"
        }
      },
      "workflow_status": {
        "data": {
          "type": "workflow_statuses",
          "id": "2607"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "372",
    "type": "tasks",
    "attributes": {
      "title": "test name",
      "description": null,
      "number": "2",
      "task_number": "2",
      "private": true,
      "due_date": "2019-05-06",
      "start_date": "2019-05-05",
      "closed_at": null,
      "created_at": "2025-08-12T06:18:19.023+02:00",
      "updated_at": "2025-08-12T06:18:19.023+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "ab387e9b1adeb67dca9791aa547d1cfa",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": null,
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:19.000+02:00",
      "initial_estimate": 60,
      "remaining_time": 60,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1979"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/tasks

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/title"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/project"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/task_list"
      }
    }
  ]
}

POST  /api/v2/tasks

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "test name",
      "type_id": "3"
    },
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "1966"
        }
      },
      "task_list": {
        "data": {
          "type": "task_lists",
          "id": "385"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "380",
    "type": "tasks",
    "attributes": {
      "title": "test name",
      "description": null,
      "number": "2",
      "task_number": "2",
      "private": false,
      "due_date": null,
      "start_date": null,
      "closed_at": null,
      "created_at": "2025-08-12T06:18:20.730+02:00",
      "updated_at": "2025-08-12T06:18:20.730+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "2dd5cbf0f33988703b7091c5d2f00c48",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": null,
      "task_dependency_count": 0,
      "type_id": 3,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:20.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1985"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Create a task
POST/api/v2/tasks

URI Parameters
HideShow
project_id
number (required) Example: 1

project id

task_list_id
number (required) Example: 1

task list id

workflow_status_id
number (optional) Example: 1

workflow status id. If not send on task create, task gets opened in the projects default workflow status.

title
string (required) Example: Title

title

assignee_id
number (optional) Example: 1

assignee id

description
string (optional) Example: Some+description

description

due_date
date (optional) Example: 2022-02-14

due date

initial_estimate
number (optional) Example: 60

initial estimate in minutes

private
boolean (optional) Example: true

is task private

start_date
date (optional) Example: 2022-02-14

start date

PATCH /api/v2/tasks/1
Requestsupdates task and tracks intercom eventupdates taskreturns errorupdates task and copies overlapping custom field valuesupdates task and sets empty custom fields

PATCH  /api/v2/tasks/381

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "new title",
      "tag_list": [
        "bug",
        "ux"
      ]
    },
    "relationships": {
      "subscribers": {
        "data": [
          {
            "type": "people",
            "id": "7975"
          },
          {
            "type": "people",
            "id": "7976"
          }
        ]
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "381",
    "type": "tasks",
    "attributes": {
      "title": "new title",
      "description": null,
      "number": "1",
      "task_number": "1",
      "private": false,
      "due_date": null,
      "start_date": null,
      "closed_at": null,
      "created_at": "2025-08-12T06:18:20.983+02:00",
      "updated_at": "2025-08-12T06:18:21.180+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "9648358cb89213e3a89cc58fd6d1ab21",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": [],
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [
        "bug",
        "ux"
      ],
      "last_activity_at": "2025-08-12T06:18:20.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1986"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/tasks/382

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "new title",
      "tag_list": [
        "bug",
        "ux"
      ],
      "private": true
    },
    "relationships": {
      "subscribers": {
        "data": [
          {
            "type": "people",
            "id": "7979"
          },
          {
            "type": "people",
            "id": "7980"
          }
        ]
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "382",
    "type": "tasks",
    "attributes": {
      "title": "new title",
      "description": null,
      "number": "1",
      "task_number": "1",
      "private": true,
      "due_date": null,
      "start_date": null,
      "closed_at": null,
      "created_at": "2025-08-12T06:18:21.455+02:00",
      "updated_at": "2025-08-12T06:18:21.673+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "95ce95759162d7785322d72e9fe03e58",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": [],
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [
        "bug",
        "ux"
      ],
      "last_activity_at": "2025-08-12T06:18:21.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1987"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/tasks/383

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/title"
      }
    }
  ]
}

PATCH  /api/v2/tasks/392

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {},
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "1978"
        }
      },
      "task_list": {
        "data": {
          "type": "task_lists",
          "id": "397"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "392",
    "type": "tasks",
    "attributes": {
      "title": "Ticket title",
      "description": null,
      "number": "1",
      "task_number": "1",
      "private": false,
      "due_date": null,
      "start_date": null,
      "closed_at": null,
      "created_at": "2025-08-12T06:18:24.282+02:00",
      "updated_at": "2025-08-12T06:18:24.469+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "4efc09e521c9b4f0240ad3af6da31b52",
      "custom_fields": {
        "20": "library"
      },
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": [],
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": 1010000,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:24.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1996"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/tasks/393

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {},
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "1980"
        }
      },
      "task_list": {
        "data": {
          "type": "task_lists",
          "id": "399"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "393",
    "type": "tasks",
    "attributes": {
      "title": "Ticket title",
      "description": null,
      "number": "1",
      "task_number": "1",
      "private": false,
      "due_date": null,
      "start_date": null,
      "closed_at": null,
      "created_at": "2025-08-12T06:18:24.739+02:00",
      "updated_at": "2025-08-12T06:18:24.912+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "99419287b86dfabf881e79673d1ddebc",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": [],
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": 1010000,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:24.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1997"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Update a task
PATCH/api/v2/tasks/{id}

URI Parameters
HideShow
id
number (required) Example: 1

task id

DELETE /api/v2/tasks/1
Requestsarchives task and deletes comments

DELETE  /api/v2/tasks/403

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Deletes a task
DELETE/api/v2/tasks/{id}

URI Parameters
HideShow
id
number (required) Example: 1

task id

POST /api/v2/tasks/copy
Requestscopy from templatecopy from templatecopy from templatecopy from templatecopy from templatecopy from templatecopy from templatecopy from templatecopies from template and sets closed_atreturns errorreturns errorreturns errorreturns error

POST  /api/v2/tasks/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "template_id": 404,
      "project_id": 2001,
      "task_list_id": 410,
      "workflow_status_id": 2729
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "405",
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "description": null,
      "number": "2",
      "task_number": "2",
      "private": false,
      "due_date": null,
      "start_date": null,
      "closed_at": null,
      "created_at": "2025-08-12T06:18:29.379+02:00",
      "updated_at": "2025-08-12T06:18:29.379+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "d249dc0f4b5f0015eeedb3229ad34bb8",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": null,
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:29.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2006"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/tasks/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "template_id": 406,
      "project_id": 2002,
      "task_list_id": 411,
      "workflow_status_id": 2733
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "407",
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "description": null,
      "number": "2",
      "task_number": "2",
      "private": false,
      "due_date": null,
      "start_date": null,
      "closed_at": null,
      "created_at": "2025-08-12T06:18:29.677+02:00",
      "updated_at": "2025-08-12T06:18:29.677+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "c20befbd2c9e1ce5cd86fdc7dad8ea22",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": null,
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:29.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2007"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/tasks/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "template_id": 408,
      "project_id": 2003,
      "task_list_id": 412,
      "copy_attachments": true,
      "workflow_status_id": 2737
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "409",
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "description": null,
      "number": "2",
      "task_number": "2",
      "private": false,
      "due_date": null,
      "start_date": null,
      "closed_at": null,
      "created_at": "2025-08-12T06:18:29.998+02:00",
      "updated_at": "2025-08-12T06:18:30.020+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "dffe62c1a771d6db7c3c2d04267497af",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": null,
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:29.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2008"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/tasks/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "template_id": 410,
      "project_id": 2004,
      "task_list_id": 413,
      "copy_open_todos": true,
      "workflow_status_id": 2741
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "411",
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "description": null,
      "number": "2",
      "task_number": "2",
      "private": false,
      "due_date": null,
      "start_date": null,
      "closed_at": null,
      "created_at": "2025-08-12T06:18:30.312+02:00",
      "updated_at": "2025-08-12T06:18:30.312+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "2694d0fbaca8fd481e4028603b704527",
      "custom_fields": null,
      "todo_count": 2,
      "open_todo_count": 2,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": null,
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:30.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2009"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/tasks/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "template_id": 412,
      "project_id": 2005,
      "task_list_id": 414,
      "private": true,
      "workflow_status_id": 2745
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "413",
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "description": null,
      "number": "2",
      "task_number": "2",
      "private": true,
      "due_date": null,
      "start_date": null,
      "closed_at": null,
      "created_at": "2025-08-12T06:18:30.713+02:00",
      "updated_at": "2025-08-12T06:18:30.713+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "82ec62809ac0aac05916f23593ddcd9e",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": null,
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:30.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2010"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/tasks/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "template_id": 414,
      "project_id": 2006,
      "task_list_id": 415,
      "private": true,
      "copy_subscribers": true,
      "workflow_status_id": 2749
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "415",
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "description": null,
      "number": "2",
      "task_number": "2",
      "private": true,
      "due_date": null,
      "start_date": null,
      "closed_at": null,
      "created_at": "2025-08-12T06:18:31.149+02:00",
      "updated_at": "2025-08-12T06:18:31.149+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "fc5853ab9c8ef26f811c10e6f6f1c489",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": null,
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:31.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2011"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/tasks/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "template_id": 416,
      "project_id": 2007,
      "task_list_id": 416,
      "private": false,
      "workflow_status_id": 2753
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "417",
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "description": null,
      "number": "2",
      "task_number": "2",
      "private": false,
      "due_date": null,
      "start_date": null,
      "closed_at": null,
      "created_at": "2025-08-12T06:18:31.419+02:00",
      "updated_at": "2025-08-12T06:18:31.419+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "99466c6b96dcf9a8b26032f2bf02ad7c",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": null,
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:31.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2012"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/tasks/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "template_id": 418,
      "project_id": 2008,
      "task_list_id": 417,
      "private": false,
      "copy_subscribers": true,
      "workflow_status_id": 2757
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "419",
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "description": null,
      "number": "2",
      "task_number": "2",
      "private": false,
      "due_date": null,
      "start_date": null,
      "closed_at": null,
      "created_at": "2025-08-12T06:18:31.686+02:00",
      "updated_at": "2025-08-12T06:18:31.686+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "92979afbbe5678835016312be0a88283",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": null,
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": false,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:31.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2013"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/tasks/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "template_id": 420,
      "project_id": 2009,
      "task_list_id": 418,
      "private": false,
      "copy_subscribers": true,
      "workflow_status_id": 2760
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "421",
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "description": null,
      "number": "2",
      "task_number": "2",
      "private": false,
      "due_date": null,
      "start_date": null,
      "closed_at": "2025-08-12T06:18:31.000+02:00",
      "created_at": "2025-08-12T06:18:31.961+02:00",
      "updated_at": "2025-08-12T06:18:31.961+02:00",
      "repeat_schedule_id": null,
      "repeat_on_interval": null,
      "repeat_on_monthday": null,
      "repeat_on_weekday": [],
      "repeat_on_date": null,
      "repeat_origin_id": null,
      "email_key": "b930ed3fe591adb45e9181eb04dfffcd",
      "custom_fields": null,
      "todo_count": null,
      "open_todo_count": null,
      "subtask_count": null,
      "open_subtask_count": null,
      "creation_method_id": 1,
      "todo_assignee_ids": null,
      "task_dependency_count": 0,
      "type_id": 1,
      "blocking_dependency_count": 0,
      "waiting_on_dependency_count": 0,
      "linked_dependency_count": 0,
      "placement": null,
      "subtask_placement": null,
      "closed": true,
      "due_time": null,
      "tag_list": [],
      "last_activity_at": "2025-08-12T06:18:31.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2014"
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "assignee": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "task_list": {
        "meta": {
          "included": false
        }
      },
      "parent_task": {
        "meta": {
          "included": false
        }
      },
      "workflow_status": {
        "meta": {
          "included": false
        }
      },
      "repeated_task": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "custom_field_attachments": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/tasks/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {}
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/title"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/template"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/project"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/task_list"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/workflow_status"
      }
    }
  ]
}

POST  /api/v2/tasks/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "template_id": 423,
      "project_id": 2011,
      "task_list_id": 420,
      "workflow_status_id": null
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/workflow_status"
      }
    }
  ]
}

POST  /api/v2/tasks/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "title": "copy test name",
      "template_id": 424,
      "project_id": 2012,
      "task_list_id": 421,
      "private": true,
      "copy_open_subtasks": true,
      "workflow_status_id": 2773
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "task can't be private",
      "source": {
        "pointer": "data/attributes/private"
      }
    }
  ]
}

PATCH  /api/v2/tasks/439/subscribers

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "tasks",
    "attributes": {
      "subscriber_ids": [
        8102
      ]
    }
  }
}
Responses404
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "404",
      "code": "record_not_found",
      "title": "Record Not Found",
      "detail": "The requested record was not found",
      "source": {}
    }
  ]
}

Copies a task
POST/api/v2/tasks/copy

URI Parameters
HideShow
id
number (required) Example: 439

Generated by aglio on 12 Aug 2025