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": "311",
      "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-09-03T06:19:43.621+02:00",
        "updated_at": "2025-09-03T06:19:43.621+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": "95b86c6d1bf9ab21a80e85a6ea392913",
        "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-09-03T06:19: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": "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
          }
        }
      }
    }
  ],
  "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": "324",
      "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-09-03T06:19:46.620+02:00",
        "updated_at": "2025-09-03T06:19:46.620+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": "9fe71a5bb5a0522d02b25f144b4a10fc",
        "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-09-03T06:19:46.000+02:00",
        "initial_estimate": null,
        "remaining_time": null,
        "billable_time": null,
        "worked_time": null,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1992"
          }
        },
        "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/327

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": "327",
    "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-09-03T06:19:47.093+02:00",
      "updated_at": "2025-09-03T06:19:47.093+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": "3849797883d80d67eb4942f33695715d",
      "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-09-03T06:19:47.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1994"
        }
      },
      "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": "361"
        }
      },
      "workflow_status": {
        "data": {
          "type": "workflow_statuses",
          "id": "2545"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "330",
    "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-09-03T06:19:47.000+02:00",
      "created_at": "2025-09-03T06:19:47.678+02:00",
      "updated_at": "2025-09-03T06:19:47.678+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": "0063b26d4ba6944146242058169c0f4e",
      "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-09-03T06:19: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": "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": {}
}

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": "363"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "334",
    "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-09-03T06:19:48.330+02:00",
      "updated_at": "2025-09-03T06:19:48.330+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": "41cf4b95e6853c70bd76bcbc4468a3fe",
      "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-09-03T06:19:48.000+02:00",
      "initial_estimate": 60,
      "remaining_time": 60,
      "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
        }
      }
    }
  },
  "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": "364"
        }
      },
      "workflow_status": {
        "data": {
          "type": "workflow_statuses",
          "id": "2558"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "336",
    "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-09-03T06:19:48.597+02:00",
      "updated_at": "2025-09-03T06:19:48.597+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": "ebfb0ded425bd5ce81d0b980f8a14698",
      "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-09-03T06:19:48.000+02:00",
      "initial_estimate": 60,
      "remaining_time": 60,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1999"
        }
      },
      "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": "370"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "344",
    "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-09-03T06:19:50.243+02:00",
      "updated_at": "2025-09-03T06:19:50.243+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": "6d34a879a2ebb807acdc34e0301b73b0",
      "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-09-03T06:19:50.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "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": {}
}

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/345

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": "7957"
          },
          {
            "type": "people",
            "id": "7958"
          }
        ]
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "345",
    "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-09-03T06:19:50.489+02:00",
      "updated_at": "2025-09-03T06:19:50.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": "6e922eeb62195e8c8944f2909616a728",
      "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-09-03T06:19:50.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": {}
}

PATCH  /api/v2/tasks/346

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": "7961"
          },
          {
            "type": "people",
            "id": "7962"
          }
        ]
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "346",
    "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-09-03T06:19:50.978+02:00",
      "updated_at": "2025-09-03T06:19:51.192+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": "373e0d0d7594a8f7cfc5132c7418973c",
      "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-09-03T06:19:50.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": {}
}

PATCH  /api/v2/tasks/347

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/356

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": "382"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "356",
    "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-09-03T06:19:54.205+02:00",
      "updated_at": "2025-09-03T06:19:54.405+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": "ce29b8c54b173c907cd7d0298801b255",
      "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-09-03T06:19:54.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2016"
        }
      },
      "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/357

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": "384"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "357",
    "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-09-03T06:19:54.662+02:00",
      "updated_at": "2025-09-03T06:19:54.869+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": "e83dbcfeb804fea7e4e59f3976aca897",
      "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-09-03T06:19:54.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2017"
        }
      },
      "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/367

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 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": 368,
      "project_id": 2001,
      "task_list_id": 395,
      "workflow_status_id": 2680
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "369",
    "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-09-03T06:19:59.736+02:00",
      "updated_at": "2025-09-03T06:19:59.736+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": "b26c11d6fedb6c0f8be558fb5694d43d",
      "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-09-03T06:19:59.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2026"
        }
      },
      "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": 370,
      "project_id": 2002,
      "task_list_id": 396,
      "workflow_status_id": 2684
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "371",
    "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-09-03T06:20:00.033+02:00",
      "updated_at": "2025-09-03T06:20:00.033+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": "19370b15f7bade145dfaea7b4458302d",
      "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-09-03T06:20:00.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2027"
        }
      },
      "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": 372,
      "project_id": 2003,
      "task_list_id": 397,
      "copy_attachments": true,
      "workflow_status_id": 2688
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "373",
    "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-09-03T06:20:00.350+02:00",
      "updated_at": "2025-09-03T06:20:00.368+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": "be9332a417128dd89226a78202a79ee1",
      "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-09-03T06:20:00.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2028"
        }
      },
      "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": 374,
      "project_id": 2004,
      "task_list_id": 398,
      "copy_open_todos": true,
      "workflow_status_id": 2692
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "375",
    "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-09-03T06:20:00.657+02:00",
      "updated_at": "2025-09-03T06:20:00.657+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": "4a7e41de346c4a85af4b6b1d48e93a5f",
      "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-09-03T06:20:00.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2029"
        }
      },
      "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": 376,
      "project_id": 2005,
      "task_list_id": 399,
      "private": true,
      "workflow_status_id": 2696
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "377",
    "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-09-03T06:20:00.945+02:00",
      "updated_at": "2025-09-03T06:20:00.945+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": "bfbaab9f9df64f779e385af3e94d7d60",
      "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-09-03T06:20:00.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2030"
        }
      },
      "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": 378,
      "project_id": 2006,
      "task_list_id": 400,
      "private": true,
      "copy_subscribers": true,
      "workflow_status_id": 2700
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "379",
    "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-09-03T06:20:01.221+02:00",
      "updated_at": "2025-09-03T06:20:01.221+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": "8962df1ef3ed1cfdf510f9f26450b5ae",
      "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-09-03T06:20:01.000+02:00",
      "initial_estimate": null,
      "remaining_time": null,
      "billable_time": null,
      "worked_time": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2031"
        }
      },
      "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": 380,
      "project_id": 2007,
      "task_list_id": 401,
      "private": false,
      "workflow_status_id": 2704
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "381",
    "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-09-03T06:20:01.509+02:00",
      "updated_at": "2025-09-03T06:20:01.509+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": "9329998bb47c3ed706f1cf1a24f28325",
      "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-09-03T06:20:01.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": 382,
      "project_id": 2008,
      "task_list_id": 402,
      "private": false,
      "copy_subscribers": true,
      "workflow_status_id": 2708
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "383",
    "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-09-03T06:20:01.786+02:00",
      "updated_at": "2025-09-03T06:20:01.786+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": "d6db7fddc57834f2d31b4c18118c0bb1",
      "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-09-03T06:20:01.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": 384,
      "project_id": 2009,
      "task_list_id": 403,
      "private": false,
      "copy_subscribers": true,
      "workflow_status_id": 2711
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "385",
    "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-09-03T06:20:02.000+02:00",
      "created_at": "2025-09-03T06:20:02.084+02:00",
      "updated_at": "2025-09-03T06:20:02.084+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": "109966c6623f8144e4cc74891215b58a",
      "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-09-03T06:20:02.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": {}
  }
}
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": 387,
      "project_id": 2011,
      "task_list_id": 405,
      "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": 388,
      "project_id": 2012,
      "task_list_id": 406,
      "private": true,
      "copy_open_subtasks": true,
      "workflow_status_id": 2724
    }
  }
}
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"
      }
    }
  ]
}

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

URI Parameters
HideShow
id
number (required) Example: 1

task id

PATCH /api/v2/tasks/1/reposition
Requestsrepositions task before another taskrepositions task after another taskrepositions task between tasks

PATCH  /api/v2/tasks/404/reposition

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": {
      "move_before_id": 405
    }
  }
}
Responses204
This response has no content.

PATCH  /api/v2/tasks/406/reposition

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": {
      "move_after_id": 407
    }
  }
}
Responses204
This response has no content.

PATCH  /api/v2/tasks/408/reposition

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": {
      "move_after_id": 409,
      "move_before_id": 410
    }
  }
}
Responses204
This response has no content.

Repositions a task
PATCH/api/v2/tasks/{id}/reposition

URI Parameters
HideShow
id
number (required) Example: 1

task id

move_before_id
number (optional) Example: 1

id of the task to move before

move_after_id
number (optional) Example: 1

id of the task to move after

Generated by aglio on 03 Sep 2025