API Documentation

API Endpoint

Projects

Projects

Supported filter params

  • id

  • project_type (1: internal, 2: client)

  • company_id (array)

  • responsible_id (array)

  • person_id (array)

  • status (1: active, 2: archived)

  • query

Filter operations are supported on this endpoint.

GET /api/v2/projects
Requestsreturns projectsreturns projects

GET  /api/v2/projects

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "299",
      "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": true,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-06-16T01:05:34.261+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": 602
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2054"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1557"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "300",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 2,
        "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:34.276+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": 602
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2055"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1557"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "301",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 3,
        "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:34.291+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": 602
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2056"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1557"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "2054",
      "type": "companies",
      "attributes": {
        "name": "Client1453",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:05:34.259+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": 602
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1557",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1506@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:05:34.000+02:00",
        "last_seen_at": "2021-06-16T01:05:34.315+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1546,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:05:34.237+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 602
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2053"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2055",
      "type": "companies",
      "attributes": {
        "name": "Client1454",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:05:34.273+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": 602
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2056",
      "type": "companies",
      "attributes": {
        "name": "Client1455",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:05:34.289+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": 602
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2053",
      "type": "companies",
      "attributes": {
        "name": "Organization602",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:05:34.236+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": 602
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/projects?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/projects?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 3,
    "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/projects

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "435",
      "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": true,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2021-06-16T01:06:02.558+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": 706
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2495"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1854"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "436",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 2,
        "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:06:02.573+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": 706
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2496"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1854"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "437",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 3,
        "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:06:02.588+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": 706
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2497"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1854"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "2495",
      "type": "companies",
      "attributes": {
        "name": "Client1790",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:06:02.556+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": 706
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1854",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1797@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:06:02.000+02:00",
        "last_seen_at": "2021-06-16T01:06:02.607+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1837,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:06:02.535+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 706
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2494"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2496",
      "type": "companies",
      "attributes": {
        "name": "Client1791",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:06:02.571+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": 706
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2497",
      "type": "companies",
      "attributes": {
        "name": "Client1792",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:06:02.585+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": 706
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2494",
      "type": "companies",
      "attributes": {
        "name": "Organization706",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:06:02.534+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": 706
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/projects?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/projects?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 3,
    "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 projects
GET/api/v2/projects


GET /api/v2/projects/1
Requestsreturns projectreturns project

GET  /api/v2/projects/302

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "302",
    "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": true,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2021-06-16T01:05:34.443+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": 603
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2058"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1558"
        }
      },
      "last_actor": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2058",
      "type": "companies",
      "attributes": {
        "name": "Client1456",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:05:34.441+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": 603
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1558",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1507@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:05:34.000+02:00",
        "last_seen_at": "2021-06-16T01:05:34.463+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1547,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:05:34.419+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 603
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2057"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2057",
      "type": "companies",
      "attributes": {
        "name": "Organization603",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:05:34.418+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": 603
          }
        },
        "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/projects/438

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "438",
    "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": true,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2021-06-16T01:06:02.723+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": 707
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2499"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1855"
        }
      },
      "last_actor": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2499",
      "type": "companies",
      "attributes": {
        "name": "Client1793",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:06:02.720+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": 707
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1855",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1798@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:06:02.000+02:00",
        "last_seen_at": "2021-06-16T01:06:02.742+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1838,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:06:02.698+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 707
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2498"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2498",
      "type": "companies",
      "attributes": {
        "name": "Organization707",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:06:02.697+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": 707
          }
        },
        "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": {}
  }
}

Gets a project
GET/api/v2/projects/{id}

URI Parameters
HideShow
id
number (required) Example: 1

project id


POST /api/v2/projects
Requestscreates projectreturns errorcreates projectreturns error

POST  /api/v2/projects

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": "projects",
    "attributes": {
      "name": "test name",
      "project_type_id": 2
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "2066"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1563"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "306",
    "type": "projects",
    "attributes": {
      "name": "test name",
      "number": 2,
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": null,
      "public_access": false,
      "time_on_tasks": false,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2021-06-16T01:05:34.893+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": 606
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2066"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1563"
        }
      },
      "last_actor": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2066",
      "type": "companies",
      "attributes": {
        "name": "Client1461",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:05:34.859+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": 606
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1563",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1512@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:05:34.000+02:00",
        "last_seen_at": "2021-06-16T01:05:34.883+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1552,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:05:34.837+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 606
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2065"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2065",
      "type": "companies",
      "attributes": {
        "name": "Organization606",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:05:34.836+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": 606
          }
        },
        "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/projects

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": "projects",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/project_manager"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/company"
      }
    }
  ]
}

POST  /api/v2/projects

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": "projects",
    "attributes": {
      "name": "test name",
      "project_type_id": 2
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "2507"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1860"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "442",
    "type": "projects",
    "attributes": {
      "name": "test name",
      "number": 2,
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": null,
      "public_access": false,
      "time_on_tasks": false,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2021-06-16T01:06:03.193+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": 710
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2507"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1860"
        }
      },
      "last_actor": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2507",
      "type": "companies",
      "attributes": {
        "name": "Client1798",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:06:03.159+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": 710
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1860",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1803@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:06:03.000+02:00",
        "last_seen_at": "2021-06-16T01:06:03.186+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1843,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:06:03.113+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 710
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2506"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2506",
      "type": "companies",
      "attributes": {
        "name": "Organization710",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:06:03.112+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": 710
          }
        },
        "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/projects

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": "projects",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/project_manager"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/company"
      }
    }
  ]
}

Create a project
POST/api/v2/projects

URI Parameters
HideShow
name
string (required) Example: Name

name

project_manager_id
number (required) Example: 1

project manager id

company_id
number (required) Example: 1

company id


PATCH /api/v2/projects/1
Requestsupdates projectreturns errorupdates projectreturns error

PATCH  /api/v2/projects/310

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": "projects",
    "attributes": {
      "name": "new name"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "310",
    "type": "projects",
    "attributes": {
      "name": "new name",
      "number": 1,
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": null,
      "public_access": true,
      "time_on_tasks": true,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2021-06-16T01:05:35.304+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": 610
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2074"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1567"
        }
      },
      "last_actor": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2074",
      "type": "companies",
      "attributes": {
        "name": "Client1465",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:05:35.301+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": 610
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1567",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1516@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:05:35.000+02:00",
        "last_seen_at": "2021-06-16T01:05:35.327+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1556,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:05:35.279+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 610
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2073"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2073",
      "type": "companies",
      "attributes": {
        "name": "Organization610",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:05:35.277+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": 610
          }
        },
        "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/projects/311

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": "projects",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

PATCH  /api/v2/projects/446

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": "projects",
    "attributes": {
      "name": "new name"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "446",
    "type": "projects",
    "attributes": {
      "name": "new name",
      "number": 1,
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": null,
      "public_access": true,
      "time_on_tasks": true,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2021-06-16T01:06:03.576+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": 714
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2515"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1864"
        }
      },
      "last_actor": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2515",
      "type": "companies",
      "attributes": {
        "name": "Client1802",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:06:03.573+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": 714
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1864",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1807@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:06:03.000+02:00",
        "last_seen_at": "2021-06-16T01:06:03.597+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1847,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:06:03.551+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 714
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2514"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2514",
      "type": "companies",
      "attributes": {
        "name": "Organization714",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:06:03.549+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": 714
          }
        },
        "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/projects/447

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": "projects",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

Update a project
PATCH/api/v2/projects/{id}

URI Parameters
HideShow
id
number (required) Example: 1

project id


PATCH /api/v2/projects/1/archive
Requestsarchives projectarchives project

PATCH  /api/v2/projects/312/archive

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "312",
    "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": true,
      "tag_colors": {},
      "archived_at": "2021-06-16T01:05:35.000+02:00",
      "created_at": "2021-06-16T01:05:35.523+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": 612
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2078"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1569"
        }
      },
      "last_actor": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2078",
      "type": "companies",
      "attributes": {
        "name": "Client1467",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:05:35.520+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": 612
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1569",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1518@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:05:35.000+02:00",
        "last_seen_at": "2021-06-16T01:05:35.543+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1558,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:05:35.497+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 612
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2077"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2077",
      "type": "companies",
      "attributes": {
        "name": "Organization612",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:05:35.496+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": 612
          }
        },
        "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/projects/448/archive

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "448",
    "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": true,
      "tag_colors": {},
      "archived_at": "2021-06-16T01:06:03.000+02:00",
      "created_at": "2021-06-16T01:06:03.799+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": 716
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2519"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1866"
        }
      },
      "last_actor": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2519",
      "type": "companies",
      "attributes": {
        "name": "Client1804",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:06:03.796+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": 716
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1866",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1809@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:06:03.000+02:00",
        "last_seen_at": "2021-06-16T01:06:03.821+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1849,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:06:03.773+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 716
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2518"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2518",
      "type": "companies",
      "attributes": {
        "name": "Organization716",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:06:03.772+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": 716
          }
        },
        "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 project
PATCH/api/v2/projects/{id}/archive

URI Parameters
HideShow
id
number (required) Example: 1

project id


PATCH /api/v2/projects/1/restore
Requestsrestores projectrestores project

PATCH  /api/v2/projects/313/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "313",
    "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:35.647+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": 613
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2080"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1570"
        }
      },
      "last_actor": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2080",
      "type": "companies",
      "attributes": {
        "name": "Client1468",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:05:35.645+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": 613
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1570",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1519@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:05:35.000+02:00",
        "last_seen_at": "2021-06-16T01:05:35.668+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1559,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:05:35.622+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 613
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2079"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2079",
      "type": "companies",
      "attributes": {
        "name": "Organization613",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:05:35.621+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": 613
          }
        },
        "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/projects/449/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "449",
    "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:06:03.923+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": 717
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2521"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1867"
        }
      },
      "last_actor": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2521",
      "type": "companies",
      "attributes": {
        "name": "Client1805",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:06:03.920+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": 717
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1867",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1810@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:06:03.000+02:00",
        "last_seen_at": "2021-06-16T01:06:03.944+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1850,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:06:03.898+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 717
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2520"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2520",
      "type": "companies",
      "attributes": {
        "name": "Organization717",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:06:03.896+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": 717
          }
        },
        "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 project
PATCH/api/v2/projects/{id}/restore

URI Parameters
HideShow
id
number (required) Example: 1

project id


DELETE /api/v2/projects/1
Requestsdeletes projectdeletes project

DELETE  /api/v2/projects/314

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

DELETE  /api/v2/projects/450

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Deletes a project
DELETE/api/v2/projects/{id}

URI Parameters
HideShow
id
number (required) Example: 1

project id


POST /api/v2/projects/copy
Requestscreates projectcreates projectreturns errorcreates projectcreates projectreturns error

POST  /api/v2/projects/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "projects",
    "attributes": {
      "name": "This is a name",
      "template_id": 315,
      "company_id": 2090,
      "project_type_id": 2,
      "copy_project_members": true,
      "copy_boards": true,
      "copy_task_lists": true,
      "copy_tasks": true,
      "copy_task_comments": false,
      "copy_task_subscribers": false,
      "copy_assignees": false,
      "copy_tags": false,
      "copy_estimate": true,
      "copy_views": true
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "316",
    "type": "projects",
    "attributes": {
      "name": "This is a name",
      "number": null,
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": null,
      "public_access": true,
      "time_on_tasks": true,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2021-06-16T01:05:36.130+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": 615
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2090"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1572"
        }
      },
      "last_actor": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2090",
      "type": "companies",
      "attributes": {
        "name": "Client1476",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:05:36.106+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": 615
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1572",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1521@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:05:36.000+02:00",
        "last_seen_at": "2021-06-16T01:05:36.117+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1561,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:05:35.854+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 615
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2083"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2083",
      "type": "companies",
      "attributes": {
        "name": "Organization615",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:05:35.852+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": 615
          }
        },
        "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/projects/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "projects",
    "attributes": {
      "name": "This is a name",
      "public_access": false,
      "template_id": 317,
      "project_type_id": 1,
      "copy_project_members": true,
      "copy_boards": true,
      "copy_task_lists": true,
      "copy_tasks": true,
      "copy_task_comments": false,
      "copy_task_subscribers": false,
      "copy_assignees": false,
      "copy_tags": false,
      "copy_estimate": true
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "318",
    "type": "projects",
    "attributes": {
      "name": "This is a name",
      "number": null,
      "project_type_id": 1,
      "project_color_id": null,
      "last_activity_at": null,
      "public_access": false,
      "time_on_tasks": true,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2021-06-16T01:05:36.577+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": 616
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2091"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1578"
        }
      },
      "last_actor": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2091",
      "type": "companies",
      "attributes": {
        "name": "Organization616",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:05:36.307+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": 616
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1578",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1527@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:05:36.000+02:00",
        "last_seen_at": "2021-06-16T01:05:36.568+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1567,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:05:36.308+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 616
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2091"
          }
        },
        "subsidiary": {
          "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/projects/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "projects",
    "attributes": {}
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/template_id"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/project_type_id"
      }
    }
  ]
}

POST  /api/v2/projects/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "projects",
    "attributes": {
      "name": "This is a name",
      "template_id": 451,
      "company_id": 2531,
      "project_type_id": 2,
      "copy_project_members": true,
      "copy_boards": true,
      "copy_task_lists": true,
      "copy_tasks": true,
      "copy_task_comments": false,
      "copy_task_subscribers": false,
      "copy_assignees": false,
      "copy_tags": false,
      "copy_estimate": true,
      "copy_views": true
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "452",
    "type": "projects",
    "attributes": {
      "name": "This is a name",
      "number": null,
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": null,
      "public_access": true,
      "time_on_tasks": true,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2021-06-16T01:06:04.349+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": 719
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2531"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1869"
        }
      },
      "last_actor": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2531",
      "type": "companies",
      "attributes": {
        "name": "Client1813",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-06-16T01:06:04.331+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": 719
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1869",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1812@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:06:04.000+02:00",
        "last_seen_at": "2021-06-16T01:06:04.341+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1852,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:06:04.104+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 719
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2524"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "2524",
      "type": "companies",
      "attributes": {
        "name": "Organization719",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:06:04.103+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": 719
          }
        },
        "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/projects/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "projects",
    "attributes": {
      "name": "This is a name",
      "public_access": false,
      "template_id": 453,
      "project_type_id": 1,
      "copy_project_members": true,
      "copy_boards": true,
      "copy_task_lists": true,
      "copy_tasks": true,
      "copy_task_comments": false,
      "copy_task_subscribers": false,
      "copy_assignees": false,
      "copy_tags": false,
      "copy_estimate": true
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "454",
    "type": "projects",
    "attributes": {
      "name": "This is a name",
      "number": null,
      "project_type_id": 1,
      "project_color_id": null,
      "last_activity_at": null,
      "public_access": false,
      "time_on_tasks": true,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2021-06-16T01:06:04.780+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": 720
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "2532"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "1875"
        }
      },
      "last_actor": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2532",
      "type": "companies",
      "attributes": {
        "name": "Organization720",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-06-16T01:06:04.484+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": 720
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1875",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1818@email.com",
        "title": null,
        "joined_at": "2021-06-16T01:06:04.000+02:00",
        "last_seen_at": "2021-06-16T01:06:04.771+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 1858,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-06-16T01:06:04.485+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {},
        "sample_data": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 720
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2532"
          }
        },
        "subsidiary": {
          "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/projects/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "projects",
    "attributes": {}
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/template_id"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/project_type_id"
      }
    }
  ]
}

Copies a project
POST/api/v2/projects/copy


Generated by aglio on 15 Jun 2021