API Documentation
Task Lists ¶
Task Lists ¶
Supported filter params
-
id
-
project_id (array)
-
board_id (array)
-
status (active: 1, archived: 2)
GET /api/v2/task_lists
Requests
GET /api/v2/task_lists?filter[project_id]=1378
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
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "213",
"type": "task_lists",
"attributes": {
"name": "task list name",
"position": 1,
"archived_at": null,
"email_key": "a8b879adaf5ddb9d88cb4fd81553f2e7"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1202
}
},
"project": {
"data": {
"type": "projects",
"id": "1378"
}
},
"board": {
"data": {
"type": "boards",
"id": "228"
}
}
}
}
],
"included": [
{
"id": "1378",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-01-24T00:08:31.507+01:00",
"board_count": 1,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1202
}
},
"company": {
"data": {
"type": "companies",
"id": "6331"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "4260"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "228",
"type": "boards",
"attributes": {
"name": "Board204",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1202
}
},
"project": {
"data": {
"type": "projects",
"id": "1378"
}
}
}
},
{
"id": "6331",
"type": "companies",
"attributes": {
"name": "Client5139",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:08:31.505+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1202
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "4260",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4202@email.com",
"title": null,
"joined_at": "2021-01-24T00:08:31.000+01:00",
"last_seen_at": "2021-01-24T00:08:31.540+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:08:31.483+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1202
}
},
"company": {
"data": {
"type": "companies",
"id": "6330"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "6330",
"type": "companies",
"attributes": {
"name": "Organization1202",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:08:31.482+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1202
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/task_lists?filter%5Bproject_id%5D=1378&page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/task_lists?filter%5Bproject_id%5D=1378&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,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"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
},
"duplicate_tasks": {
"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
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Get task listsGET/api/v2/task_lists
GET /api/v2/task_lists/1
Requests
GET /api/v2/task_lists/214
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
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "214",
"type": "task_lists",
"attributes": {
"name": "task list name",
"position": 1,
"archived_at": null,
"email_key": "1aeec988169206c149a8a7b632f7d163"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1203
}
},
"project": {
"data": {
"type": "projects",
"id": "1379"
}
},
"board": {
"data": {
"type": "boards",
"id": "229"
}
}
}
},
"included": [
{
"id": "1379",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-01-24T00:08:31.638+01:00",
"board_count": 1,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1203
}
},
"company": {
"data": {
"type": "companies",
"id": "6333"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "4261"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "229",
"type": "boards",
"attributes": {
"name": "Board205",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1203
}
},
"project": {
"data": {
"type": "projects",
"id": "1379"
}
}
}
},
{
"id": "6333",
"type": "companies",
"attributes": {
"name": "Client5140",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:08:31.636+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1203
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "4261",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4203@email.com",
"title": null,
"joined_at": "2021-01-24T00:08:31.000+01:00",
"last_seen_at": "2021-01-24T00:08:31.671+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:08:31.615+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1203
}
},
"company": {
"data": {
"type": "companies",
"id": "6332"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "6332",
"type": "companies",
"attributes": {
"name": "Organization1203",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:08:31.614+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1203
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"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
},
"duplicate_tasks": {
"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
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/task_lists
Requests
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": "1380"
}
},
"board": {
"data": {
"type": "boards",
"id": "230"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "216",
"type": "task_lists",
"attributes": {
"name": "test name",
"position": 2,
"archived_at": null,
"email_key": "2479173c87780712386c9325e5b3e54e"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1204
}
},
"project": {
"data": {
"type": "projects",
"id": "1380"
}
},
"board": {
"data": {
"type": "boards",
"id": "230"
}
}
}
},
"included": [
{
"id": "1380",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-01-24T00:08:31.766+01:00",
"board_count": 1,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1204
}
},
"company": {
"data": {
"type": "companies",
"id": "6335"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "4262"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "230",
"type": "boards",
"attributes": {
"name": "Board206",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1204
}
},
"project": {
"data": {
"type": "projects",
"id": "1380"
}
}
}
},
{
"id": "6335",
"type": "companies",
"attributes": {
"name": "Client5141",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:08:31.764+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1204
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "4262",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4204@email.com",
"title": null,
"joined_at": "2021-01-24T00:08:31.000+01:00",
"last_seen_at": "2021-01-24T00:08:31.800+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:08:31.743+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1204
}
},
"company": {
"data": {
"type": "companies",
"id": "6334"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "6334",
"type": "companies",
"attributes": {
"name": "Organization1204",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:08:31.742+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1204
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"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
},
"duplicate_tasks": {
"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
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"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": ""
}
}
}
Responses
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 listPOST/api/v2/task_lists
URI Parameters
- name
string
(required) Example: Namename
- project_id
number
(required) Example: 1project id
- board_id
number
(required) Example: 1board id
PATCH /api/v2/task_lists/1
Requests
PATCH /api/v2/task_lists/220
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"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "220",
"type": "task_lists",
"attributes": {
"name": "new name",
"position": 1,
"archived_at": null,
"email_key": "90ff1a9def70d8616106fe7bed83cf98"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1208
}
},
"project": {
"data": {
"type": "projects",
"id": "1384"
}
},
"board": {
"data": {
"type": "boards",
"id": "234"
}
}
}
},
"included": [
{
"id": "1384",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-01-24T00:08:32.243+01:00",
"board_count": 1,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1208
}
},
"company": {
"data": {
"type": "companies",
"id": "6343"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "4266"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "234",
"type": "boards",
"attributes": {
"name": "Board210",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1208
}
},
"project": {
"data": {
"type": "projects",
"id": "1384"
}
}
}
},
{
"id": "6343",
"type": "companies",
"attributes": {
"name": "Client5145",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:08:32.241+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1208
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "4266",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4208@email.com",
"title": null,
"joined_at": "2021-01-24T00:08:32.000+01:00",
"last_seen_at": "2021-01-24T00:08:32.277+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:08:32.219+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1208
}
},
"company": {
"data": {
"type": "companies",
"id": "6342"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "6342",
"type": "companies",
"attributes": {
"name": "Organization1208",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:08:32.218+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1208
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"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
},
"duplicate_tasks": {
"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
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Update a task listPATCH/api/v2/task_lists/{id}
URI Parameters
- id
number
(required) Example: 1task list id
PATCH /api/v2/task_lists/1/archive
Requests
PATCH /api/v2/task_lists/221/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
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "221",
"type": "task_lists",
"attributes": {
"name": "task list name",
"position": null,
"archived_at": "2021-01-24T00:08:32.000+01:00",
"email_key": "a3ec0ad873bd71a0281c8a25b8a82843"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1209
}
},
"project": {
"data": {
"type": "projects",
"id": "1385"
}
},
"board": {
"data": {
"type": "boards",
"id": "235"
}
}
}
},
"included": [
{
"id": "1385",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-01-24T00:08:32.428+01:00",
"board_count": 1,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1209
}
},
"company": {
"data": {
"type": "companies",
"id": "6345"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "4267"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "235",
"type": "boards",
"attributes": {
"name": "Board211",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1209
}
},
"project": {
"data": {
"type": "projects",
"id": "1385"
}
}
}
},
{
"id": "6345",
"type": "companies",
"attributes": {
"name": "Client5146",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:08:32.425+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1209
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "4267",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4209@email.com",
"title": null,
"joined_at": "2021-01-24T00:08:32.000+01:00",
"last_seen_at": "2021-01-24T00:08:32.462+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:08:32.403+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1209
}
},
"company": {
"data": {
"type": "companies",
"id": "6344"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "6344",
"type": "companies",
"attributes": {
"name": "Organization1209",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:08:32.402+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1209
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"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
},
"duplicate_tasks": {
"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
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Archives a task listPATCH/api/v2/task_lists/{id}/archive
URI Parameters
- id
number
(required) Example: 1task list id
PATCH /api/v2/task_lists/1/restore
Requests
PATCH /api/v2/task_lists/222/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
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "222",
"type": "task_lists",
"attributes": {
"name": "Milestone205",
"position": 2,
"archived_at": null,
"email_key": "5a53890db1c51a582d359bc827f81780"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1210
}
},
"project": {
"data": {
"type": "projects",
"id": "1386"
}
},
"board": {
"data": {
"type": "boards",
"id": "236"
}
}
}
},
"included": [
{
"id": "1386",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-01-24T00:08:32.599+01:00",
"board_count": 1,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1210
}
},
"company": {
"data": {
"type": "companies",
"id": "6347"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "4268"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "236",
"type": "boards",
"attributes": {
"name": "Board212",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1210
}
},
"project": {
"data": {
"type": "projects",
"id": "1386"
}
}
}
},
{
"id": "6347",
"type": "companies",
"attributes": {
"name": "Client5147",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:08:32.596+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1210
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "4268",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4210@email.com",
"title": null,
"joined_at": "2021-01-24T00:08:32.000+01:00",
"last_seen_at": "2021-01-24T00:08:32.633+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:08:32.574+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1210
}
},
"company": {
"data": {
"type": "companies",
"id": "6346"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "6346",
"type": "companies",
"attributes": {
"name": "Organization1210",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:08:32.573+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1210
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"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
},
"duplicate_tasks": {
"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
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Restores a task listPATCH/api/v2/task_lists/{id}/restore
URI Parameters
- id
number
(required) Example: 1task list id
Generated by aglio on 23 Jan 2021