API Documentation
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
Requests
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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "337",
"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-09-21T01:06:09.277+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 675
}
},
"company": {
"data": {
"type": "companies",
"id": "2431"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1794"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "338",
"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-09-21T01:06:09.291+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 675
}
},
"company": {
"data": {
"type": "companies",
"id": "2432"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1794"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "339",
"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-09-21T01:06:09.306+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 675
}
},
"company": {
"data": {
"type": "companies",
"id": "2433"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1794"
}
},
"last_actor": {
"data": null
}
}
}
],
"included": [
{
"id": "2431",
"type": "companies",
"attributes": {
"name": "Client1757",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:06:09.274+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 675
}
}
}
},
{
"id": "1794",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1743@email.com",
"title": null,
"joined_at": "2021-09-21T01:06:09.000+02:00",
"last_seen_at": "2021-09-21T01:06:09.328+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 1783,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:06:09.251+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 675
}
},
"company": {
"data": {
"type": "companies",
"id": "2430"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2432",
"type": "companies",
"attributes": {
"name": "Client1758",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:06:09.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": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 675
}
}
}
},
{
"id": "2433",
"type": "companies",
"attributes": {
"name": "Client1759",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:06:09.303+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 675
}
}
}
},
{
"id": "2430",
"type": "companies",
"attributes": {
"name": "Organization675",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:06:09.250+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 675
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"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+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "636",
"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-09-21T01:07:31.956+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 841
}
},
"company": {
"data": {
"type": "companies",
"id": "3469"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "2458"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "637",
"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-09-21T01:07:31.970+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 841
}
},
"company": {
"data": {
"type": "companies",
"id": "3470"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "2458"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "638",
"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-09-21T01:07:31.983+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 841
}
},
"company": {
"data": {
"type": "companies",
"id": "3471"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "2458"
}
},
"last_actor": {
"data": null
}
}
}
],
"included": [
{
"id": "3469",
"type": "companies",
"attributes": {
"name": "Client2629",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:07:31.954+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 841
}
}
}
},
{
"id": "2458",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2401@email.com",
"title": null,
"joined_at": "2021-09-21T01:07:32.000+02:00",
"last_seen_at": "2021-09-21T01:07:32.002+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 2441,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:07:31.932+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 841
}
},
"company": {
"data": {
"type": "companies",
"id": "3468"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "3470",
"type": "companies",
"attributes": {
"name": "Client2630",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:07:31.968+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 841
}
}
}
},
{
"id": "3471",
"type": "companies",
"attributes": {
"name": "Client2631",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:07:31.981+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 841
}
}
}
},
{
"id": "3468",
"type": "companies",
"attributes": {
"name": "Organization841",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:07:31.931+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 841
}
}
}
}
],
"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
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get projectsGET/api/v2/projects
GET /api/v2/projects/1
Requests
GET /api/v2/projects/340
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "340",
"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-09-21T01:06:09.423+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 676
}
},
"company": {
"data": {
"type": "companies",
"id": "2435"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1795"
}
},
"last_actor": {
"data": null
}
}
},
"included": [
{
"id": "2435",
"type": "companies",
"attributes": {
"name": "Client1760",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:06:09.420+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 676
}
}
}
},
{
"id": "1795",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1744@email.com",
"title": null,
"joined_at": "2021-09-21T01:06:09.000+02:00",
"last_seen_at": "2021-09-21T01:06:09.443+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 1784,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:06:09.397+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 676
}
},
"company": {
"data": {
"type": "companies",
"id": "2434"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2434",
"type": "companies",
"attributes": {
"name": "Organization676",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:06:09.396+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 676
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}GET /api/v2/projects/639
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "639",
"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-09-21T01:07:32.096+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 842
}
},
"company": {
"data": {
"type": "companies",
"id": "3473"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "2459"
}
},
"last_actor": {
"data": null
}
}
},
"included": [
{
"id": "3473",
"type": "companies",
"attributes": {
"name": "Client2632",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:07:32.094+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 842
}
}
}
},
{
"id": "2459",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2402@email.com",
"title": null,
"joined_at": "2021-09-21T01:07:32.000+02:00",
"last_seen_at": "2021-09-21T01:07:32.117+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 2442,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:07:32.067+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 842
}
},
"company": {
"data": {
"type": "companies",
"id": "3472"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "3472",
"type": "companies",
"attributes": {
"name": "Organization842",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:07:32.066+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 842
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}POST /api/v2/projects
Requests
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+jsonBody
{
"data": {
"type": "projects",
"attributes": {
"name": "test name",
"project_type_id": 2
},
"relationships": {
"company": {
"data": {
"type": "companies",
"id": "2437"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1796"
}
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "342",
"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-09-21T01:06:09.552+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 677
}
},
"company": {
"data": {
"type": "companies",
"id": "2437"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1796"
}
},
"last_actor": {
"data": null
}
}
},
"included": [
{
"id": "2437",
"type": "companies",
"attributes": {
"name": "Client1761",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:06:09.518+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 677
}
}
}
},
{
"id": "1796",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1745@email.com",
"title": null,
"joined_at": "2021-09-21T01:06:09.000+02:00",
"last_seen_at": "2021-09-21T01:06:09.540+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 1785,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:06:09.495+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 677
}
},
"company": {
"data": {
"type": "companies",
"id": "2436"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2436",
"type": "companies",
"attributes": {
"name": "Organization677",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:06:09.493+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 677
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"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+jsonBody
{
"data": {
"type": "projects",
"attributes": {
"name": ""
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
},
{
"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+jsonBody
{
"data": {
"type": "projects",
"attributes": {
"name": "test name",
"project_type_id": 2
},
"relationships": {
"company": {
"data": {
"type": "companies",
"id": "3475"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "2460"
}
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "641",
"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-09-21T01:07:32.229+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 843
}
},
"company": {
"data": {
"type": "companies",
"id": "3475"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "2460"
}
},
"last_actor": {
"data": null
}
}
},
"included": [
{
"id": "3475",
"type": "companies",
"attributes": {
"name": "Client2633",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:07:32.197+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 843
}
}
}
},
{
"id": "2460",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2403@email.com",
"title": null,
"joined_at": "2021-09-21T01:07:32.000+02:00",
"last_seen_at": "2021-09-21T01:07:32.222+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 2443,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:07:32.172+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 843
}
},
"company": {
"data": {
"type": "companies",
"id": "3474"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "3474",
"type": "companies",
"attributes": {
"name": "Organization843",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:07:32.171+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 843
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"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+jsonBody
{
"data": {
"type": "projects",
"attributes": {
"name": ""
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
},
{
"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 projectPOST/api/v2/projects
URI Parameters
- name
string(required) Example: Namename
- project_manager_id
number(required) Example: 1project manager id
- company_id
number(required) Example: 1company id
PATCH /api/v2/projects/1
Requests
PATCH /api/v2/projects/346
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "projects",
"attributes": {
"name": "new name"
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "346",
"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-09-21T01:06:09.947+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 681
}
},
"company": {
"data": {
"type": "companies",
"id": "2445"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1800"
}
},
"last_actor": {
"data": null
}
}
},
"included": [
{
"id": "2445",
"type": "companies",
"attributes": {
"name": "Client1765",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:06:09.944+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 681
}
}
}
},
{
"id": "1800",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1749@email.com",
"title": null,
"joined_at": "2021-09-21T01:06:09.000+02:00",
"last_seen_at": "2021-09-21T01:06:09.971+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 1789,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:06:09.898+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 681
}
},
"company": {
"data": {
"type": "companies",
"id": "2444"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2444",
"type": "companies",
"attributes": {
"name": "Organization681",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:06:09.897+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 681
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/projects/347
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "projects",
"attributes": {
"name": ""
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}PATCH /api/v2/projects/645
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "projects",
"attributes": {
"name": "new name"
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "645",
"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-09-21T01:07:32.640+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 847
}
},
"company": {
"data": {
"type": "companies",
"id": "3483"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "2464"
}
},
"last_actor": {
"data": null
}
}
},
"included": [
{
"id": "3483",
"type": "companies",
"attributes": {
"name": "Client2637",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:07:32.637+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 847
}
}
}
},
{
"id": "2464",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2407@email.com",
"title": null,
"joined_at": "2021-09-21T01:07:32.000+02:00",
"last_seen_at": "2021-09-21T01:07:32.662+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 2447,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:07:32.612+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 847
}
},
"company": {
"data": {
"type": "companies",
"id": "3482"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "3482",
"type": "companies",
"attributes": {
"name": "Organization847",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:07:32.611+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 847
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/projects/646
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "projects",
"attributes": {
"name": ""
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}PATCH /api/v2/projects/1/archive
Requests
PATCH /api/v2/projects/348/archive
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "348",
"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-09-21T01:06:10.000+02:00",
"created_at": "2021-09-21T01:06:10.160+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 683
}
},
"company": {
"data": {
"type": "companies",
"id": "2449"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1802"
}
},
"last_actor": {
"data": null
}
}
},
"included": [
{
"id": "2449",
"type": "companies",
"attributes": {
"name": "Client1767",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:06:10.158+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 683
}
}
}
},
{
"id": "1802",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1751@email.com",
"title": null,
"joined_at": "2021-09-21T01:06:10.000+02:00",
"last_seen_at": "2021-09-21T01:06:10.180+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 1791,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:06:10.135+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 683
}
},
"company": {
"data": {
"type": "companies",
"id": "2448"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2448",
"type": "companies",
"attributes": {
"name": "Organization683",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:06:10.134+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 683
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/projects/647/archive
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "647",
"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-09-21T01:07:32.000+02:00",
"created_at": "2021-09-21T01:07:32.879+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 849
}
},
"company": {
"data": {
"type": "companies",
"id": "3487"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "2466"
}
},
"last_actor": {
"data": null
}
}
},
"included": [
{
"id": "3487",
"type": "companies",
"attributes": {
"name": "Client2639",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:07:32.876+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 849
}
}
}
},
{
"id": "2466",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2409@email.com",
"title": null,
"joined_at": "2021-09-21T01:07:32.000+02:00",
"last_seen_at": "2021-09-21T01:07:32.904+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 2449,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:07:32.848+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 849
}
},
"company": {
"data": {
"type": "companies",
"id": "3486"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "3486",
"type": "companies",
"attributes": {
"name": "Organization849",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:07:32.846+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 849
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Archives a projectPATCH/api/v2/projects/{id}/archive
URI Parameters
- id
number(required) Example: 1project id
PATCH /api/v2/projects/1/restore
Requests
PATCH /api/v2/projects/349/restore
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "349",
"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-09-21T01:06:10.271+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 684
}
},
"company": {
"data": {
"type": "companies",
"id": "2451"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1803"
}
},
"last_actor": {
"data": null
}
}
},
"included": [
{
"id": "2451",
"type": "companies",
"attributes": {
"name": "Client1768",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:06:10.268+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 684
}
}
}
},
{
"id": "1803",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1752@email.com",
"title": null,
"joined_at": "2021-09-21T01:06:10.000+02:00",
"last_seen_at": "2021-09-21T01:06:10.292+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 1792,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:06:10.241+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 684
}
},
"company": {
"data": {
"type": "companies",
"id": "2450"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2450",
"type": "companies",
"attributes": {
"name": "Organization684",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:06:10.239+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 684
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/projects/648/restore
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "648",
"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-09-21T01:07:32.991+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 850
}
},
"company": {
"data": {
"type": "companies",
"id": "3489"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "2467"
}
},
"last_actor": {
"data": null
}
}
},
"included": [
{
"id": "3489",
"type": "companies",
"attributes": {
"name": "Client2640",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:07:32.988+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 850
}
}
}
},
{
"id": "2467",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2410@email.com",
"title": null,
"joined_at": "2021-09-21T01:07:33.000+02:00",
"last_seen_at": "2021-09-21T01:07:33.010+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 2450,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:07:32.967+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 850
}
},
"company": {
"data": {
"type": "companies",
"id": "3488"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "3488",
"type": "companies",
"attributes": {
"name": "Organization850",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:07:32.965+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 850
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Restores a projectPATCH/api/v2/projects/{id}/restore
URI Parameters
- id
number(required) Example: 1project id
DELETE /api/v2/projects/1
Requests
DELETE /api/v2/projects/350
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
This response has no content.
DELETE /api/v2/projects/649
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
This response has no content.
POST /api/v2/projects/copy
Requests
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+jsonBody
{
"data": {
"type": "projects",
"attributes": {
"name": "This is a name",
"template_id": 351,
"company_id": 2461,
"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
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "352",
"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-09-21T01:06:10.714+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 686
}
},
"company": {
"data": {
"type": "companies",
"id": "2461"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1805"
}
},
"last_actor": {
"data": null
}
}
},
"included": [
{
"id": "2461",
"type": "companies",
"attributes": {
"name": "Client1776",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:06:10.689+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 686
}
}
}
},
{
"id": "1805",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1754@email.com",
"title": null,
"joined_at": "2021-09-21T01:06:10.000+02:00",
"last_seen_at": "2021-09-21T01:06:10.700+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 1794,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:06:10.449+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 686
}
},
"company": {
"data": {
"type": "companies",
"id": "2454"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2454",
"type": "companies",
"attributes": {
"name": "Organization686",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:06:10.448+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 686
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"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+jsonBody
{
"data": {
"type": "projects",
"attributes": {
"name": "This is a name",
"public_access": false,
"template_id": 353,
"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
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "354",
"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-09-21T01:06:11.107+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 687
}
},
"company": {
"data": {
"type": "companies",
"id": "2462"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1811"
}
},
"last_actor": {
"data": null
}
}
},
"included": [
{
"id": "2462",
"type": "companies",
"attributes": {
"name": "Organization687",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:06:10.839+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 687
}
}
}
},
{
"id": "1811",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1760@email.com",
"title": null,
"joined_at": "2021-09-21T01:06:11.000+02:00",
"last_seen_at": "2021-09-21T01:06:11.098+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 1800,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:06:10.841+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 687
}
},
"company": {
"data": {
"type": "companies",
"id": "2462"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"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+jsonBody
{
"data": {
"type": "projects",
"attributes": {}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
},
{
"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+jsonBody
{
"data": {
"type": "projects",
"attributes": {
"name": "This is a name",
"template_id": 650,
"company_id": 3499,
"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
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "651",
"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-09-21T01:07:33.473+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 852
}
},
"company": {
"data": {
"type": "companies",
"id": "3499"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "2469"
}
},
"last_actor": {
"data": null
}
}
},
"included": [
{
"id": "3499",
"type": "companies",
"attributes": {
"name": "Client2648",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-09-21T01:07:33.453+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 852
}
}
}
},
{
"id": "2469",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2412@email.com",
"title": null,
"joined_at": "2021-09-21T01:07:33.000+02:00",
"last_seen_at": "2021-09-21T01:07:33.465+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 2452,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:07:33.175+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 852
}
},
"company": {
"data": {
"type": "companies",
"id": "3492"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "3492",
"type": "companies",
"attributes": {
"name": "Organization852",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:07:33.173+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 852
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"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+jsonBody
{
"data": {
"type": "projects",
"attributes": {
"name": "This is a name",
"public_access": false,
"template_id": 652,
"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
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "653",
"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-09-21T01:07:33.872+02:00",
"budget_closing_date": null,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 853
}
},
"company": {
"data": {
"type": "companies",
"id": "3500"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "2475"
}
},
"last_actor": {
"data": null
}
}
},
"included": [
{
"id": "3500",
"type": "companies",
"attributes": {
"name": "Organization853",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-09-21T01:07:33.605+02:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 853
}
}
}
},
{
"id": "2475",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user2418@email.com",
"title": null,
"joined_at": "2021-09-21T01:07:33.000+02:00",
"last_seen_at": "2021-09-21T01:07:33.865+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"setting_role_id": null,
"invited_at": null,
"is_user": true,
"user_id": 2458,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-09-21T01:07:33.607+02:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 853
}
},
"company": {
"data": {
"type": "companies",
"id": "3500"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 100
},
"private_custom_reports": {
"type": "metered",
"limit": 30
},
"public_project_reports": {
"type": "metered",
"limit": 30
},
"private_project_reports": {
"type": "metered",
"limit": 10
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5
},
"recycle_bin": {
"type": "restricted",
"available": true,
"limit": 180
},
"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
},
"timeline_layout": {
"type": "switch",
"available": true
},
"comment_visibility": {
"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+jsonBody
{
"data": {
"type": "projects",
"attributes": {}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
},
{
"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 projectPOST/api/v2/projects/copy
Generated by aglio on 20 Sep 2021