API Documentation

API Endpoint

Task Lists

Task Lists

Supported filter params

  • id

  • project_id (array)

  • board_id (array)

  • status (active: 1, archived: 2)

Supported relationship filter params

  • board

  • project

GET /api/v2/task_lists
Requestsreturns task lists

GET  /api/v2/task_lists?filter[project_id]=1947

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": "398",
      "type": "task_lists",
      "attributes": {
        "name": "task list name",
        "position": 1,
        "placement": null,
        "archived_at": null,
        "email_key": "2d2b693c6deb108ccc3caab56f455e2c"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1908"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1947"
          }
        },
        "board": {
          "data": {
            "type": "boards",
            "id": "417"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1947",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "1",
        "project_number": "1",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2024-03-28T05:15:57.000+01:00",
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2024-03-28T05:15:57.563+01:00",
        "template": false,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1908"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5958"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "7848"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "7848"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2284"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "417",
      "type": "boards",
      "attributes": {
        "name": "Board386",
        "position": 1,
        "placement": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1908"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1947"
          }
        }
      }
    },
    {
      "id": "5958",
      "type": "companies",
      "attributes": {
        "name": "Client4099",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:15:57.531+01:00",
        "last_activity_at": "2024-03-28T05:15:57.531+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1908"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7848",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 1,
        "email": "user7763@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": "2024-03-28T05:15:57.000+01:00",
        "last_seen_at": "2024-03-28T05:15:57.605+01:00",
        "archived_at": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 7827,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:15:57.501+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": null,
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1908"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8208"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "2284",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1908"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2662"
            }
          ]
        }
      }
    },
    {
      "id": "8208",
      "type": "roles",
      "attributes": {
        "base_role_id": 1,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1908"
          }
        }
      }
    },
    {
      "id": "2662",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": 1,
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1908"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2284"
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/task_lists?filter%5Bproject_id%5D=1947&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/task_lists?filter%5Bproject_id%5D=1947&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,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get task lists
GET/api/v2/task_lists


GET /api/v2/task_lists/1
Requestsreturns task list

GET  /api/v2/task_lists/399

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": "399",
    "type": "task_lists",
    "attributes": {
      "name": "task list name",
      "position": 1,
      "placement": null,
      "archived_at": null,
      "email_key": "48e7c3ace3d91fb68fc5bedbe9f31a5a"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1909"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "1948"
        }
      },
      "board": {
        "data": {
          "type": "boards",
          "id": "418"
        }
      }
    }
  },
  "included": [
    {
      "id": "1948",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "1",
        "project_number": "1",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2024-03-28T05:15:57.000+01:00",
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2024-03-28T05:15:57.722+01:00",
        "template": false,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1909"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5960"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "7849"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "7849"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2285"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "418",
      "type": "boards",
      "attributes": {
        "name": "Board387",
        "position": 1,
        "placement": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1909"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1948"
          }
        }
      }
    },
    {
      "id": "5960",
      "type": "companies",
      "attributes": {
        "name": "Client4100",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:15:57.715+01:00",
        "last_activity_at": "2024-03-28T05:15:57.715+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1909"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7849",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 1,
        "email": "user7764@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": "2024-03-28T05:15:57.000+01:00",
        "last_seen_at": "2024-03-28T05:15:57.759+01:00",
        "archived_at": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 7828,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:15:57.685+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": null,
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1909"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8209"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "2285",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1909"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2663"
            }
          ]
        }
      }
    },
    {
      "id": "8209",
      "type": "roles",
      "attributes": {
        "base_role_id": 1,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1909"
          }
        }
      }
    },
    {
      "id": "2663",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": 1,
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1909"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2285"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Gets a task list
GET/api/v2/task_lists/{id}

URI Parameters
HideShow
id
number (required) Example: 1

task list id


POST /api/v2/task_lists
Requestscreates task listreturns error

POST  /api/v2/task_lists

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": "task_lists",
    "attributes": {
      "name": "test name"
    },
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "1949"
        }
      },
      "board": {
        "data": {
          "type": "boards",
          "id": "419"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "401",
    "type": "task_lists",
    "attributes": {
      "name": "test name",
      "position": 2,
      "placement": null,
      "archived_at": null,
      "email_key": "d331c17a410394de709785009328b6c5"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1910"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "1949"
        }
      },
      "board": {
        "data": {
          "type": "boards",
          "id": "419"
        }
      }
    }
  },
  "included": [
    {
      "id": "1949",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "1",
        "project_number": "1",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2024-03-28T05:15:57.000+01:00",
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2024-03-28T05:15:57.874+01:00",
        "template": false,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1910"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5962"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "7850"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "7850"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2286"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "419",
      "type": "boards",
      "attributes": {
        "name": "Board388",
        "position": 1,
        "placement": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1910"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1949"
          }
        }
      }
    },
    {
      "id": "5962",
      "type": "companies",
      "attributes": {
        "name": "Client4101",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:15:57.867+01:00",
        "last_activity_at": "2024-03-28T05:15:57.867+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1910"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7850",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 1,
        "email": "user7765@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": "2024-03-28T05:15:57.000+01:00",
        "last_seen_at": "2024-03-28T05:15:57.912+01:00",
        "archived_at": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 7829,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:15:57.839+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": null,
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1910"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8210"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "2286",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1910"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2664"
            }
          ]
        }
      }
    },
    {
      "id": "8210",
      "type": "roles",
      "attributes": {
        "base_role_id": 1,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1910"
          }
        }
      }
    },
    {
      "id": "2664",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": 1,
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1910"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2286"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

POST  /api/v2/task_lists

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": "task_lists",
    "attributes": {
      "name": ""
    }
  }
}
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/name"
      }
    },
    {
      "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/board"
      }
    }
  ]
}

Create a task list
POST/api/v2/task_lists

URI Parameters
HideShow
name
string (required) Example: Name

name

project_id
number (required) Example: 1

project id

board_id
number (required) Example: 1

board id


PATCH /api/v2/task_lists/1
Requestsupdates task list

PATCH  /api/v2/task_lists/405

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": "task_lists",
    "attributes": {
      "name": "new name"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "405",
    "type": "task_lists",
    "attributes": {
      "name": "new name",
      "position": 1,
      "placement": null,
      "archived_at": null,
      "email_key": "b57fe52f9bacfe6fe0935407e9c46bff"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1914"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "1953"
        }
      },
      "board": {
        "data": {
          "type": "boards",
          "id": "423"
        }
      }
    }
  },
  "included": [
    {
      "id": "1953",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "1",
        "project_number": "1",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2024-03-28T05:15:58.000+01:00",
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2024-03-28T05:15:58.379+01:00",
        "template": false,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1914"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5970"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "7854"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "7854"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2290"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "423",
      "type": "boards",
      "attributes": {
        "name": "Board392",
        "position": 1,
        "placement": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1914"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1953"
          }
        }
      }
    },
    {
      "id": "5970",
      "type": "companies",
      "attributes": {
        "name": "Client4105",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:15:58.373+01:00",
        "last_activity_at": "2024-03-28T05:15:58.373+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1914"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7854",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 1,
        "email": "user7769@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": "2024-03-28T05:15:58.000+01:00",
        "last_seen_at": "2024-03-28T05:15:58.416+01:00",
        "archived_at": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 7833,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:15:58.345+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": null,
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1914"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8214"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "2290",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1914"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2668"
            }
          ]
        }
      }
    },
    {
      "id": "8214",
      "type": "roles",
      "attributes": {
        "base_role_id": 1,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1914"
          }
        }
      }
    },
    {
      "id": "2668",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": 1,
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1914"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2290"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Update a task list
PATCH/api/v2/task_lists/{id}

URI Parameters
HideShow
id
number (required) Example: 1

task list id


PATCH /api/v2/task_lists/1/archive
Requestsarchives task list

PATCH  /api/v2/task_lists/406/archive

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": "406",
    "type": "task_lists",
    "attributes": {
      "name": "task list name",
      "position": null,
      "placement": null,
      "archived_at": "2024-03-28T05:15:58.000+01:00",
      "email_key": "1841091dc3539ce64b7c66a5b19956f9"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1915"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "1954"
        }
      },
      "board": {
        "data": {
          "type": "boards",
          "id": "424"
        }
      }
    }
  },
  "included": [
    {
      "id": "1954",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "1",
        "project_number": "1",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2024-03-28T05:15:58.000+01:00",
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2024-03-28T05:15:58.540+01:00",
        "template": false,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1915"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5972"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "7855"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "7855"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2291"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "424",
      "type": "boards",
      "attributes": {
        "name": "Board393",
        "position": 1,
        "placement": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1915"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1954"
          }
        }
      }
    },
    {
      "id": "5972",
      "type": "companies",
      "attributes": {
        "name": "Client4106",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:15:58.533+01:00",
        "last_activity_at": "2024-03-28T05:15:58.533+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1915"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7855",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 1,
        "email": "user7770@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": "2024-03-28T05:15:58.000+01:00",
        "last_seen_at": "2024-03-28T05:15:58.588+01:00",
        "archived_at": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 7834,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:15:58.503+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": null,
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1915"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8215"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "2291",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1915"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2669"
            }
          ]
        }
      }
    },
    {
      "id": "8215",
      "type": "roles",
      "attributes": {
        "base_role_id": 1,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1915"
          }
        }
      }
    },
    {
      "id": "2669",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": 1,
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1915"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2291"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Archives a task list
PATCH/api/v2/task_lists/{id}/archive

URI Parameters
HideShow
id
number (required) Example: 1

task list id


PATCH /api/v2/task_lists/1/restore
Requestsrestores task list

PATCH  /api/v2/task_lists/407/restore

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": "407",
    "type": "task_lists",
    "attributes": {
      "name": "Milestone387",
      "position": 2,
      "placement": null,
      "archived_at": null,
      "email_key": "663bb717fca25e9f1ed654cd2db091e1"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1916"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "1955"
        }
      },
      "board": {
        "data": {
          "type": "boards",
          "id": "425"
        }
      }
    }
  },
  "included": [
    {
      "id": "1955",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "1",
        "project_number": "1",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2024-03-28T05:15:58.000+01:00",
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2024-03-28T05:15:58.704+01:00",
        "template": false,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1916"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5974"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "7856"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "7856"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2292"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "425",
      "type": "boards",
      "attributes": {
        "name": "Board394",
        "position": 1,
        "placement": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1916"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1955"
          }
        }
      }
    },
    {
      "id": "5974",
      "type": "companies",
      "attributes": {
        "name": "Client4107",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:15:58.698+01:00",
        "last_activity_at": "2024-03-28T05:15:58.698+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1916"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7856",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 1,
        "email": "user7771@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": "2024-03-28T05:15:58.000+01:00",
        "last_seen_at": "2024-03-28T05:15:58.744+01:00",
        "archived_at": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 7835,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:15:58.669+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": null,
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1916"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8216"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "2292",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1916"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2670"
            }
          ]
        }
      }
    },
    {
      "id": "8216",
      "type": "roles",
      "attributes": {
        "base_role_id": 1,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1916"
          }
        }
      }
    },
    {
      "id": "2670",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": 1,
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1916"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2292"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Restores a task list
PATCH/api/v2/task_lists/{id}/restore

URI Parameters
HideShow
id
number (required) Example: 1

task list id


POST /api/v2/task_lists/copy
Requestscopy from templatecopy from templatecopy from templatecopy from template

POST  /api/v2/task_lists/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": "task_lists",
    "attributes": {
      "name": "copy task list",
      "template_id": 408,
      "project_id": 1956,
      "board_id": 426,
      "copy_tasks": true,
      "copy_assignees": true
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "409",
    "type": "task_lists",
    "attributes": {
      "name": "copy task list",
      "position": 1,
      "placement": null,
      "archived_at": null,
      "email_key": "9f40b86f8f3df2f407194569dab2e52f"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1917"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "1956"
        }
      },
      "board": {
        "data": {
          "type": "boards",
          "id": "426"
        }
      }
    }
  },
  "included": [
    {
      "id": "1956",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "1",
        "project_number": "1",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2024-03-28T05:15:58.000+01:00",
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2024-03-28T05:15:58.857+01:00",
        "template": false,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1917"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5976"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "7857"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "7857"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2293"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "426",
      "type": "boards",
      "attributes": {
        "name": "Board395",
        "position": 1,
        "placement": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1917"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1956"
          }
        }
      }
    },
    {
      "id": "5976",
      "type": "companies",
      "attributes": {
        "name": "Client4108",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:15:58.851+01:00",
        "last_activity_at": "2024-03-28T05:15:58.851+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1917"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7857",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 1,
        "email": "user7772@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": "2024-03-28T05:15:58.000+01:00",
        "last_seen_at": "2024-03-28T05:15:58.896+01:00",
        "archived_at": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 7836,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:15:58.822+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": null,
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1917"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8217"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "2293",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1917"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2671"
            }
          ]
        }
      }
    },
    {
      "id": "8217",
      "type": "roles",
      "attributes": {
        "base_role_id": 1,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1917"
          }
        }
      }
    },
    {
      "id": "2671",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": 1,
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1917"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2293"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

POST  /api/v2/task_lists/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": "task_lists",
    "attributes": {
      "name": "copy task list",
      "template_id": 410,
      "project_id": 1958,
      "board_id": 428,
      "copy_tasks": true,
      "copy_assignees": true
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "411",
    "type": "task_lists",
    "attributes": {
      "name": "copy task list",
      "position": 1,
      "placement": null,
      "archived_at": null,
      "email_key": "f7e77a643d4b15e57df144b9a29dcae4"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1918"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "1958"
        }
      },
      "board": {
        "data": {
          "type": "boards",
          "id": "428"
        }
      }
    }
  },
  "included": [
    {
      "id": "1958",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "2",
        "project_number": "2",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2024-03-28T05:15:59.000+01:00",
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2024-03-28T05:15:59.104+01:00",
        "template": false,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1918"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5979"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "7859"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "7858"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2295"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "428",
      "type": "boards",
      "attributes": {
        "name": "Board397",
        "position": 1,
        "placement": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1918"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1958"
          }
        }
      }
    },
    {
      "id": "5979",
      "type": "companies",
      "attributes": {
        "name": "Client4110",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:15:59.098+01:00",
        "last_activity_at": "2024-03-28T05:15:59.098+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE1",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1918"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7859",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 3,
        "email": "user7774@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": null,
        "last_seen_at": null,
        "archived_at": null,
        "invited_at": "2024-03-28T05:15:59.000+01:00",
        "is_user": true,
        "user_id": 7838,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:15:59.075+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": "2024-03-28T05:15:59.075+01:00",
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1918"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5977"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8219"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7858",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 1,
        "email": "user7773@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": "2024-03-28T05:15:59.000+01:00",
        "last_seen_at": "2024-03-28T05:15:59.141+01:00",
        "archived_at": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 7837,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:15:59.003+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": null,
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1918"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8218"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "2295",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1918"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2673"
            }
          ]
        }
      }
    },
    {
      "id": "5977",
      "type": "companies",
      "attributes": {
        "name": "Organization1918",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:15:59.025+01:00",
        "last_activity_at": "2024-03-28T05:15:59.025+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "ORGA",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1918"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "8219",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1918"
          }
        }
      }
    },
    {
      "id": "8218",
      "type": "roles",
      "attributes": {
        "base_role_id": 1,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1918"
          }
        }
      }
    },
    {
      "id": "2673",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": 1,
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1918"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2295"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

POST  /api/v2/task_lists/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": "task_lists",
    "attributes": {
      "name": "copy task list",
      "template_id": 412,
      "project_id": 1960,
      "board_id": 430,
      "copy_tasks": true,
      "copy_assignees": true
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "414",
    "type": "task_lists",
    "attributes": {
      "name": "copy task list",
      "position": 1,
      "placement": null,
      "archived_at": null,
      "email_key": "cc91e9e4b1eb3b1310d3ff017a79d890"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1919"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "1960"
        }
      },
      "board": {
        "data": {
          "type": "boards",
          "id": "430"
        }
      }
    }
  },
  "included": [
    {
      "id": "1960",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "2",
        "project_number": "2",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2024-03-28T05:15:59.000+01:00",
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2024-03-28T05:15:59.315+01:00",
        "template": false,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1919"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5982"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "7861"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "7860"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2297"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "430",
      "type": "boards",
      "attributes": {
        "name": "Board399",
        "position": 1,
        "placement": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1919"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1960"
          }
        }
      }
    },
    {
      "id": "5982",
      "type": "companies",
      "attributes": {
        "name": "Client4112",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:15:59.308+01:00",
        "last_activity_at": "2024-03-28T05:15:59.308+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE1",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1919"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7861",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 3,
        "email": "user7776@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": null,
        "last_seen_at": null,
        "archived_at": null,
        "invited_at": "2024-03-28T05:15:59.000+01:00",
        "is_user": true,
        "user_id": 7840,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:15:59.285+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": "2024-03-28T05:15:59.285+01:00",
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1919"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5980"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8221"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7860",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 1,
        "email": "user7775@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": "2024-03-28T05:15:59.000+01:00",
        "last_seen_at": "2024-03-28T05:15:59.630+01:00",
        "archived_at": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 7839,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:15:59.222+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": null,
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1919"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8220"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "2297",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1919"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2675"
            }
          ]
        }
      }
    },
    {
      "id": "5980",
      "type": "companies",
      "attributes": {
        "name": "Organization1919",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:15:59.243+01:00",
        "last_activity_at": "2024-03-28T05:15:59.243+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "ORGA",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1919"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "8221",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1919"
          }
        }
      }
    },
    {
      "id": "8220",
      "type": "roles",
      "attributes": {
        "base_role_id": 1,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1919"
          }
        }
      }
    },
    {
      "id": "2675",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": 1,
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1919"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2297"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

POST  /api/v2/task_lists/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": "task_lists",
    "attributes": {
      "name": "copy task list",
      "template_id": 415,
      "project_id": 1965,
      "board_id": 433,
      "copy_tasks": true,
      "copy_assignees": true
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "417",
    "type": "task_lists",
    "attributes": {
      "name": "copy task list",
      "position": 1,
      "placement": null,
      "archived_at": null,
      "email_key": "eeaec282e37fcca0099d8fed8b2e5ef2"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1920"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "1965"
        }
      },
      "board": {
        "data": {
          "type": "boards",
          "id": "433"
        }
      }
    }
  },
  "included": [
    {
      "id": "1965",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "2",
        "project_number": "2",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2024-03-28T05:15:59.000+01:00",
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2024-03-28T05:15:59.826+01:00",
        "template": false,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1920"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5988"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "7869"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "7868"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2303"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "433",
      "type": "boards",
      "attributes": {
        "name": "Board402",
        "position": 1,
        "placement": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1920"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1965"
          }
        }
      }
    },
    {
      "id": "5988",
      "type": "companies",
      "attributes": {
        "name": "Client4117",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:15:59.820+01:00",
        "last_activity_at": "2024-03-28T05:15:59.820+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE1",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1920"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7869",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 3,
        "email": "user7784@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": null,
        "last_seen_at": null,
        "archived_at": null,
        "invited_at": "2024-03-28T05:15:59.000+01:00",
        "is_user": true,
        "user_id": 7848,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:15:59.798+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": "2024-03-28T05:15:59.798+01:00",
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1920"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5986"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8229"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7868",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 1,
        "email": "user7783@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": "2024-03-28T05:16:00.000+01:00",
        "last_seen_at": "2024-03-28T05:16:00.290+01:00",
        "archived_at": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 7847,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:15:59.731+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": null,
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1920"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8228"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "2303",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1920"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2682"
            }
          ]
        }
      }
    },
    {
      "id": "5986",
      "type": "companies",
      "attributes": {
        "name": "Organization1920",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:15:59.753+01:00",
        "last_activity_at": "2024-03-28T05:15:59.753+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "ORGA",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1920"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "8229",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1920"
          }
        }
      }
    },
    {
      "id": "8228",
      "type": "roles",
      "attributes": {
        "base_role_id": 1,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1920"
          }
        }
      }
    },
    {
      "id": "2682",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": 1,
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1920"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2303"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Copies a task list
POST/api/v2/task_lists/copy

URI Parameters
HideShow
id
number (required) Example: 1

task list id


PATCH /api/v2/task_lists/1/move
Requestsmoves task list to new projectreturns errors

PATCH  /api/v2/task_lists/418/move

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": "task_lists",
    "attributes": {
      "board_id": 436
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "418",
    "type": "task_lists",
    "attributes": {
      "name": "task list name",
      "position": 1,
      "placement": null,
      "archived_at": null,
      "email_key": "23b328008c7d027d28dc645ccf10c75c"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1921"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "1970"
        }
      },
      "board": {
        "data": {
          "type": "boards",
          "id": "436"
        }
      }
    }
  },
  "included": [
    {
      "id": "1970",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "2",
        "project_number": "2",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2024-03-28T05:16:01.000+01:00",
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2024-03-28T05:16:01.043+01:00",
        "template": false,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1921"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5994"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "7878"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "7876"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2308"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "436",
      "type": "boards",
      "attributes": {
        "name": "Board405",
        "position": 1,
        "placement": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1921"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1970"
          }
        }
      }
    },
    {
      "id": "5994",
      "type": "companies",
      "attributes": {
        "name": "Client4122",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:16:01.041+01:00",
        "last_activity_at": "2024-03-28T05:16:01.041+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE1",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1921"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7878",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 3,
        "email": "user7793@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": null,
        "last_seen_at": null,
        "archived_at": null,
        "invited_at": "2024-03-28T05:16:01.000+01:00",
        "is_user": true,
        "user_id": 7857,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:16:01.019+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": "2024-03-28T05:16:01.019+01:00",
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1921"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "5992"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8238"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7876",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 1,
        "email": "user7791@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": "2024-03-28T05:16:01.000+01:00",
        "last_seen_at": "2024-03-28T05:16:01.131+01:00",
        "archived_at": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 7855,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:16:00.917+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": null,
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1921"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8236"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "2308",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1921"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2688"
            }
          ]
        }
      }
    },
    {
      "id": "5992",
      "type": "companies",
      "attributes": {
        "name": "Organization1921",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:16:00.938+01:00",
        "last_activity_at": "2024-03-28T05:16:00.938+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "ORGA",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1921"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "8238",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1921"
          }
        }
      }
    },
    {
      "id": "8236",
      "type": "roles",
      "attributes": {
        "base_role_id": 1,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1921"
          }
        }
      }
    },
    {
      "id": "2688",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": 1,
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1921"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2308"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/task_lists/419/move

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": "task_lists",
    "attributes": {
      "board_id": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "attribute is invalid",
      "source": {
        "pointer": "data/attributes/board_id"
      }
    }
  ]
}

Moves a task list
PATCH/api/v2/task_lists/{id}/move

URI Parameters
HideShow
id
number (required) Example: 1

task list id


PATCH /api/v2/task_lists/1/reposition
Requestsupdates placement

PATCH  /api/v2/task_lists/420/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": "task_lists",
    "attributes": {
      "move_before_id": 421
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "420",
    "type": "task_lists",
    "attributes": {
      "name": "task list name",
      "position": 1,
      "placement": 90000,
      "archived_at": null,
      "email_key": "6aa868e29d834f04a52d2bfaa18f8396"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1923"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "1975"
        }
      },
      "board": {
        "data": {
          "type": "boards",
          "id": "439"
        }
      }
    }
  },
  "included": [
    {
      "id": "1975",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "1",
        "project_number": "1",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2024-03-28T05:16:01.000+01:00",
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2024-03-28T05:16:01.547+01:00",
        "template": false,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1923"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "6001"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "7884"
          }
        },
        "last_actor": {
          "data": {
            "type": "people",
            "id": "7884"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2312"
          }
        },
        "custom_field_people": {
          "data": []
        },
        "template_object": {
          "data": null
        }
      }
    },
    {
      "id": "439",
      "type": "boards",
      "attributes": {
        "name": "Board408",
        "position": 1,
        "placement": null,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1923"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1975"
          }
        }
      }
    },
    {
      "id": "6001",
      "type": "companies",
      "attributes": {
        "name": "Client4127",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-28T05:16:01.541+01:00",
        "last_activity_at": "2024-03-28T05:16:01.541+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "CLIE",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1923"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "7884",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 1,
        "email": "user7799@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": "2024-03-28T05:16:01.000+01:00",
        "last_seen_at": "2024-03-28T05:16:01.629+01:00",
        "archived_at": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 7863,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-28T05:16:01.502+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": null,
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1923"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": null
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "8244"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "2312",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1923"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "2692"
            }
          ]
        }
      }
    },
    {
      "id": "8244",
      "type": "roles",
      "attributes": {
        "base_role_id": 1,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1923"
          }
        }
      }
    },
    {
      "id": "2692",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Closed",
        "color_id": 1,
        "position": 1,
        "category_id": 3
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1923"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "2312"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Repoisition a task list
PATCH/api/v2/task_lists/{id}/reposition

URI Parameters
HideShow
id
number (required) Example: 1

task list id


Generated by aglio on 28 Mar 2024