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]=1936

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-07-22T06:14:43.420+02:00",
        "updated_at": "2025-07-22T06:14:43.420+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": "5fba330de2a8fa499164fa1c788b31f4",
        "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-07-22T06:14:43.000+02:00",
        "initial_estimate": null,
        "remaining_time": null,
        "billable_time": null,
        "worked_time": null,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1993"
          }
        },
        "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=1936&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/tasks?filter%5Bproject_id%5D=1936&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]=1973

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-07-22T06:14:45.479+02:00",
        "updated_at": "2025-07-22T06:14:45.479+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": "eff0f70c65e34ef0c6c7932d90fc39b1",
        "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-07-22T06:14:45.000+02:00",
        "initial_estimate": null,
        "remaining_time": null,
        "billable_time": null,
        "worked_time": null,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1998"
          }
        },
        "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=1973&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/tasks?filter%5Bproject_id%5D=1973&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-07-22T06:14:45.882+02:00",
      "updated_at": "2025-07-22T06:14:45.882+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": "cd842a2082b853dee17d4eea62b3fd05",
      "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-07-22T06:14:45.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2000"
        }
      },
      "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": "1982"
        }
      },
      "task_list": {
        "data": {
          "type": "task_lists",
          "id": "376"
        }
      },
      "workflow_status": {
        "data": {
          "type": "workflow_statuses",
          "id": "2619"
        }
      }
    }
  }
}
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-07-22T06:14:46.000+02:00",
      "created_at": "2025-07-22T06:14:46.329+02:00",
      "updated_at": "2025-07-22T06:14:46.329+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": "dc82ee9d5cc0c0609b11e97756ec9f1a",
      "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-07-22T06:14:46.000+02:00",
      "initial_estimate": 60,
      "remaining_time": 60,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2002"
        }
      },
      "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": "1984"
        }
      },
      "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-07-22T06:14:46.785+02:00",
      "updated_at": "2025-07-22T06:14:46.785+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": "32ba2c2aa44d5a1a1a07c8e68142d83a",
      "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-07-22T06:14:46.000+02:00",
      "initial_estimate": 60,
      "remaining_time": 60,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2004"
        }
      },
      "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": "1985"
        }
      },
      "task_list": {
        "data": {
          "type": "task_lists",
          "id": "379"
        }
      },
      "workflow_status": {
        "data": {
          "type": "workflow_statuses",
          "id": "2632"
        }
      }
    }
  }
}
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-07-22T06:14:47.034+02:00",
      "updated_at": "2025-07-22T06:14:47.034+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": "ccb9b7854f72245fbb8601bf34266304",
      "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-07-22T06:14:47.000+02:00",
      "initial_estimate": 60,
      "remaining_time": 60,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2005"
        }
      },
      "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": "1991"
        }
      },
      "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-07-22T06:14:48.303+02:00",
      "updated_at": "2025-07-22T06:14:48.303+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": "e53ee04cf9a35923e9c24e973961a804",
      "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-07-22T06:14:48.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": {}
}

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": "8048"
          },
          {
            "type": "people",
            "id": "8049"
          }
        ]
      }
    }
  }
}
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-07-22T06:14:48.498+02:00",
      "updated_at": "2025-07-22T06:14:48.804+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": "46275c227b8d204480d4ef3efeb3c9ca",
      "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-07-22T06:14:48.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": {}
}

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": "8052"
          },
          {
            "type": "people",
            "id": "8053"
          }
        ]
      }
    }
  }
}
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-07-22T06:14:49.246+02:00",
      "updated_at": "2025-07-22T06:14:49.437+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": "b5bce48d48f9d5b40927e5cbba192d02",
      "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-07-22T06:14:49.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": {}
}

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": "2003"
        }
      },
      "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-07-22T06:14:51.450+02:00",
      "updated_at": "2025-07-22T06:14:51.603+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": "c5d8bb13e094ffc50c3d139212729941",
      "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-07-22T06:14:51.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2022"
        }
      },
      "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": "2005"
        }
      },
      "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-07-22T06:14:51.797+02:00",
      "updated_at": "2025-07-22T06:14:51.936+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": "d4260833d8ef85160dea8e03c583f693",
      "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-07-22T06:14:51.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2023"
        }
      },
      "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": 2026,
      "task_list_id": 410,
      "workflow_status_id": 2754
    }
  }
}
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-07-22T06:14:55.648+02:00",
      "updated_at": "2025-07-22T06:14:55.648+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": "f92110be85f2726f1460d8a506cbd11a",
      "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-07-22T06:14:55.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2032"
        }
      },
      "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": 2027,
      "task_list_id": 411,
      "workflow_status_id": 2758
    }
  }
}
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-07-22T06:14:55.888+02:00",
      "updated_at": "2025-07-22T06:14:55.888+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": "0ce63bf765ea5b95384d0b603fc0ea67",
      "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-07-22T06:14:55.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2033"
        }
      },
      "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": 2028,
      "task_list_id": 412,
      "copy_attachments": true,
      "workflow_status_id": 2762
    }
  }
}
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-07-22T06:14:56.135+02:00",
      "updated_at": "2025-07-22T06:14:56.151+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": "70519e9141562a2597fdc91e2d500a5c",
      "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-07-22T06:14:56.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2034"
        }
      },
      "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": 2029,
      "task_list_id": 413,
      "copy_open_todos": true,
      "workflow_status_id": 2766
    }
  }
}
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-07-22T06:14:56.356+02:00",
      "updated_at": "2025-07-22T06:14:56.356+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": "6dc9b7df88bd56452658743fc8a59e5f",
      "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-07-22T06:14:56.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2035"
        }
      },
      "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": 2030,
      "task_list_id": 414,
      "private": true,
      "workflow_status_id": 2770
    }
  }
}
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-07-22T06:14:56.565+02:00",
      "updated_at": "2025-07-22T06:14:56.565+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": "6539813f8cb33af6dcd1643dd32f6ab1",
      "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-07-22T06:14:56.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2036"
        }
      },
      "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": 2031,
      "task_list_id": 415,
      "private": true,
      "copy_subscribers": true,
      "workflow_status_id": 2774
    }
  }
}
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-07-22T06:14:56.777+02:00",
      "updated_at": "2025-07-22T06:14:56.777+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": "85c265272e96ad2cb9b07aa57839b8ff",
      "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-07-22T06:14:56.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2037"
        }
      },
      "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": 2032,
      "task_list_id": 416,
      "private": false,
      "workflow_status_id": 2778
    }
  }
}
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-07-22T06:14:57.000+02:00",
      "updated_at": "2025-07-22T06:14:57.000+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": "9c8afab08b988891ef4414c94ff27924",
      "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-07-22T06:14:57.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2038"
        }
      },
      "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": 2033,
      "task_list_id": 417,
      "private": false,
      "copy_subscribers": true,
      "workflow_status_id": 2782
    }
  }
}
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-07-22T06:14:57.202+02:00",
      "updated_at": "2025-07-22T06:14:57.202+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": "73b721ea1c64bbc93f8316f4db93393a",
      "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-07-22T06:14:57.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2039"
        }
      },
      "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": 2034,
      "task_list_id": 418,
      "private": false,
      "copy_subscribers": true,
      "workflow_status_id": 2785
    }
  }
}
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-07-22T06:14:57.000+02:00",
      "created_at": "2025-07-22T06:14:57.408+02:00",
      "updated_at": "2025-07-22T06:14:57.408+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": "12f825d243554ddbe22daeb80aa590d5",
      "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-07-22T06:14:57.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2040"
        }
      },
      "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": 2036,
      "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": 2037,
      "task_list_id": 421,
      "private": true,
      "copy_open_subtasks": true,
      "workflow_status_id": 2798
    }
  }
}
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": [
        8175
      ]
    }
  }
}
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 22 Jul 2025