API Documentation
Boards ¶
GET /api/v2/boards
Requests
GET /api/v2/boards?filter[project_id]=31
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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "11",
"type": "boards",
"attributes": {
"name": "board name",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 70
}
},
"project": {
"data": {
"type": "projects",
"id": "31"
}
}
}
}
],
"included": [
{
"id": "31",
"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-06-16T01:03:32.854+02: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,
"task_custom_fields_ids": null,
"sample_data": 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": 70
}
},
"company": {
"data": {
"type": "companies",
"id": "215"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "175"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "215",
"type": "companies",
"attributes": {
"name": "Client145",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:03:32.851+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 70
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "175",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user176@email.com",
"title": null,
"joined_at": "2021-06-16T01:03:32.000+02:00",
"last_seen_at": "2021-06-16T01:03:32.884+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 176,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:03:32.830+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 70
}
},
"company": {
"data": {
"type": "companies",
"id": "214"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "214",
"type": "companies",
"attributes": {
"name": "Organization70",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:03:32.829+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 70
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/boards?filter%5Bproject_id%5D=31&page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/boards?filter%5Bproject_id%5D=31&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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}GET /api/v2/boards?filter[project_id]=251
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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "68",
"type": "boards",
"attributes": {
"name": "board name",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 572
}
},
"project": {
"data": {
"type": "projects",
"id": "251"
}
}
}
}
],
"included": [
{
"id": "251",
"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-06-16T01:05:27.991+02: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,
"task_custom_fields_ids": null,
"sample_data": 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": 572
}
},
"company": {
"data": {
"type": "companies",
"id": "1911"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1461"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1911",
"type": "companies",
"attributes": {
"name": "Client1340",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:05:27.989+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 572
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1461",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1411@email.com",
"title": null,
"joined_at": "2021-06-16T01:05:28.000+02:00",
"last_seen_at": "2021-06-16T01:05:28.019+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 1451,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:05:27.967+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 572
}
},
"company": {
"data": {
"type": "companies",
"id": "1910"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1910",
"type": "companies",
"attributes": {
"name": "Organization572",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:05:27.966+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 572
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/boards?filter%5Bproject_id%5D=251&page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/boards?filter%5Bproject_id%5D=251&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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get boardsGET/api/v2/boards
GET /api/v2/boards/1
Requests
GET /api/v2/boards/12
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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "12",
"type": "boards",
"attributes": {
"name": "board name",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 71
}
},
"project": {
"data": {
"type": "projects",
"id": "32"
}
}
}
},
"included": [
{
"id": "32",
"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-06-16T01:03:32.981+02: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,
"task_custom_fields_ids": null,
"sample_data": 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": 71
}
},
"company": {
"data": {
"type": "companies",
"id": "217"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "176"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "217",
"type": "companies",
"attributes": {
"name": "Client146",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:03:32.978+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 71
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "176",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user177@email.com",
"title": null,
"joined_at": "2021-06-16T01:03:33.000+02:00",
"last_seen_at": "2021-06-16T01:03:33.008+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 177,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:03:32.957+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 71
}
},
"company": {
"data": {
"type": "companies",
"id": "216"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "216",
"type": "companies",
"attributes": {
"name": "Organization71",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:03:32.956+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 71
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}GET /api/v2/boards/69
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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "69",
"type": "boards",
"attributes": {
"name": "board name",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 573
}
},
"project": {
"data": {
"type": "projects",
"id": "252"
}
}
}
},
"included": [
{
"id": "252",
"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-06-16T01:05:28.113+02: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,
"task_custom_fields_ids": null,
"sample_data": 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": 573
}
},
"company": {
"data": {
"type": "companies",
"id": "1913"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1462"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1913",
"type": "companies",
"attributes": {
"name": "Client1341",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:05:28.111+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 573
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1462",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1412@email.com",
"title": null,
"joined_at": "2021-06-16T01:05:28.000+02:00",
"last_seen_at": "2021-06-16T01:05:28.141+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 1452,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:05:28.089+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 573
}
},
"company": {
"data": {
"type": "companies",
"id": "1912"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1912",
"type": "companies",
"attributes": {
"name": "Organization573",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:05:28.087+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 573
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}POST /api/v2/boards
Requests
POST /api/v2/boards
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+jsonBody
{
"data": {
"type": "boards",
"attributes": {
"name": "test name"
},
"relationships": {
"project": {
"data": {
"type": "projects",
"id": "33"
}
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "14",
"type": "boards",
"attributes": {
"name": "test name",
"position": 2,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 72
}
},
"project": {
"data": {
"type": "projects",
"id": "33"
}
}
}
},
"included": [
{
"id": "33",
"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-06-16T01:03:33.104+02:00",
"board_count": 2,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": 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": 72
}
},
"company": {
"data": {
"type": "companies",
"id": "219"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "177"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "219",
"type": "companies",
"attributes": {
"name": "Client147",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:03:33.101+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 72
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "177",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user178@email.com",
"title": null,
"joined_at": "2021-06-16T01:03:33.000+02:00",
"last_seen_at": "2021-06-16T01:03:33.134+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 178,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:03:33.080+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 72
}
},
"company": {
"data": {
"type": "companies",
"id": "218"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "218",
"type": "companies",
"attributes": {
"name": "Organization72",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:03:33.079+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 72
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}POST /api/v2/boards
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+jsonBody
{
"data": {
"type": "boards",
"attributes": {
"name": ""
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}POST /api/v2/boards
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+jsonBody
{
"data": {
"type": "boards",
"attributes": {
"name": "test name"
},
"relationships": {
"project": {
"data": {
"type": "projects",
"id": "253"
}
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "71",
"type": "boards",
"attributes": {
"name": "test name",
"position": 2,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 574
}
},
"project": {
"data": {
"type": "projects",
"id": "253"
}
}
}
},
"included": [
{
"id": "253",
"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-06-16T01:05:28.236+02:00",
"board_count": 2,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": 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": 574
}
},
"company": {
"data": {
"type": "companies",
"id": "1915"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1463"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1915",
"type": "companies",
"attributes": {
"name": "Client1342",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:05:28.233+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 574
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1463",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1413@email.com",
"title": null,
"joined_at": "2021-06-16T01:05:28.000+02:00",
"last_seen_at": "2021-06-16T01:05:28.264+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 1453,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:05:28.211+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 574
}
},
"company": {
"data": {
"type": "companies",
"id": "1914"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1914",
"type": "companies",
"attributes": {
"name": "Organization574",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:05:28.210+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 574
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}POST /api/v2/boards
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+jsonBody
{
"data": {
"type": "boards",
"attributes": {
"name": ""
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}PATCH /api/v2/boards/1
Requests
PATCH /api/v2/boards/17
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+jsonBody
{
"data": {
"type": "boards",
"attributes": {
"name": "new name"
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "17",
"type": "boards",
"attributes": {
"name": "new name",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 75
}
},
"project": {
"data": {
"type": "projects",
"id": "36"
}
}
}
},
"included": [
{
"id": "36",
"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-06-16T01:03:33.493+02: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,
"task_custom_fields_ids": null,
"sample_data": 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": 75
}
},
"company": {
"data": {
"type": "companies",
"id": "225"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "180"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "225",
"type": "companies",
"attributes": {
"name": "Client150",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:03:33.490+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 75
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "180",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user181@email.com",
"title": null,
"joined_at": "2021-06-16T01:03:33.000+02:00",
"last_seen_at": "2021-06-16T01:03:33.525+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 181,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:03:33.465+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 75
}
},
"company": {
"data": {
"type": "companies",
"id": "224"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "224",
"type": "companies",
"attributes": {
"name": "Organization75",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:03:33.463+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 75
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/boards/18
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+jsonBody
{
"data": {
"type": "boards",
"attributes": {
"name": ""
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}PATCH /api/v2/boards/74
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+jsonBody
{
"data": {
"type": "boards",
"attributes": {
"name": "new name"
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "74",
"type": "boards",
"attributes": {
"name": "new name",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 577
}
},
"project": {
"data": {
"type": "projects",
"id": "256"
}
}
}
},
"included": [
{
"id": "256",
"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-06-16T01:05:28.596+02: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,
"task_custom_fields_ids": null,
"sample_data": 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": 577
}
},
"company": {
"data": {
"type": "companies",
"id": "1921"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1466"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1921",
"type": "companies",
"attributes": {
"name": "Client1345",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:05:28.594+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 577
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1466",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1416@email.com",
"title": null,
"joined_at": "2021-06-16T01:05:28.000+02:00",
"last_seen_at": "2021-06-16T01:05:28.624+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 1456,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:05:28.573+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 577
}
},
"company": {
"data": {
"type": "companies",
"id": "1920"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1920",
"type": "companies",
"attributes": {
"name": "Organization577",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:05:28.572+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 577
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/boards/75
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+jsonBody
{
"data": {
"type": "boards",
"attributes": {
"name": ""
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}PATCH /api/v2/boards/1/archive
Requests
PATCH /api/v2/boards/20/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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "20",
"type": "boards",
"attributes": {
"name": "board name",
"position": null,
"archived_at": "2021-06-16T01:03:33.000+02:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 78
}
},
"project": {
"data": {
"type": "projects",
"id": "39"
}
}
}
},
"included": [
{
"id": "39",
"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-06-16T01:03:33.853+02:00",
"board_count": 0,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": 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": 78
}
},
"company": {
"data": {
"type": "companies",
"id": "231"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "183"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "231",
"type": "companies",
"attributes": {
"name": "Client153",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:03:33.851+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 78
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "183",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user184@email.com",
"title": null,
"joined_at": "2021-06-16T01:03:33.000+02:00",
"last_seen_at": "2021-06-16T01:03:33.882+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 184,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:03:33.829+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 78
}
},
"company": {
"data": {
"type": "companies",
"id": "230"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "230",
"type": "companies",
"attributes": {
"name": "Organization78",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:03:33.828+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 78
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/boards/77/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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "77",
"type": "boards",
"attributes": {
"name": "board name",
"position": null,
"archived_at": "2021-06-16T01:05:28.000+02:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 580
}
},
"project": {
"data": {
"type": "projects",
"id": "259"
}
}
}
},
"included": [
{
"id": "259",
"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-06-16T01:05:28.932+02:00",
"board_count": 0,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": 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": 580
}
},
"company": {
"data": {
"type": "companies",
"id": "1927"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1469"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1927",
"type": "companies",
"attributes": {
"name": "Client1348",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:05:28.929+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 580
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1469",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1419@email.com",
"title": null,
"joined_at": "2021-06-16T01:05:28.000+02:00",
"last_seen_at": "2021-06-16T01:05:28.960+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 1459,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:05:28.908+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 580
}
},
"company": {
"data": {
"type": "companies",
"id": "1926"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1926",
"type": "companies",
"attributes": {
"name": "Organization580",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:05:28.907+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 580
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Archives a boardPATCH/api/v2/boards/{id}/archive
URI Parameters
- id
number(required) Example: 1board id
PATCH /api/v2/boards/1/restore
Requests
PATCH /api/v2/boards/21/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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "21",
"type": "boards",
"attributes": {
"name": "Board11",
"position": 2,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 79
}
},
"project": {
"data": {
"type": "projects",
"id": "40"
}
}
}
},
"included": [
{
"id": "40",
"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-06-16T01:03:34.019+02: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,
"task_custom_fields_ids": null,
"sample_data": 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": 79
}
},
"company": {
"data": {
"type": "companies",
"id": "233"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "184"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "233",
"type": "companies",
"attributes": {
"name": "Client154",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:03:34.017+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 79
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "184",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user185@email.com",
"title": null,
"joined_at": "2021-06-16T01:03:34.000+02:00",
"last_seen_at": "2021-06-16T01:03:34.048+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 185,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:03:33.996+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 79
}
},
"company": {
"data": {
"type": "companies",
"id": "232"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "232",
"type": "companies",
"attributes": {
"name": "Organization79",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:03:33.994+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 79
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/boards/78/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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "78",
"type": "boards",
"attributes": {
"name": "Board50",
"position": 2,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 581
}
},
"project": {
"data": {
"type": "projects",
"id": "260"
}
}
}
},
"included": [
{
"id": "260",
"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-06-16T01:05:29.090+02: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,
"task_custom_fields_ids": null,
"sample_data": 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": 581
}
},
"company": {
"data": {
"type": "companies",
"id": "1929"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1470"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "1929",
"type": "companies",
"attributes": {
"name": "Client1349",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-06-16T01:05:29.087+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 581
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1470",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1420@email.com",
"title": null,
"joined_at": "2021-06-16T01:05:29.000+02:00",
"last_seen_at": "2021-06-16T01:05:29.118+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 1460,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-06-16T01:05:29.065+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 581
}
},
"company": {
"data": {
"type": "companies",
"id": "1928"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1928",
"type": "companies",
"attributes": {
"name": "Organization581",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-06-16T01:05:29.064+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 581
}
},
"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
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"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
},
"pulse": {
"type": "switch",
"available": true
},
"slack": {
"type": "switch",
"available": true
},
"task_custom_fields_library": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Restores a boardPATCH/api/v2/boards/{id}/restore
URI Parameters
- id
number(required) Example: 1board id
Generated by aglio on 15 Jun 2021