API Documentation
Pages ¶
Pages ¶
Supported filter params
-
project_id (array)
-
root_page_id
-
parent_page_id
Supported sort params
-
title
-
created_at
-
updated_at
-
project
GET /api/v2/pages
Requests
GET /api/v2/pages?filter[project_id]=295
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": "15",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:05:58.270+01:00",
"updated_at": "2021-12-06T00:05:58.270+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "509"
}
},
"project": {
"data": {
"type": "projects",
"id": "295"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
}
],
"included": [
{
"id": "295",
"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-12-06T00:05:58.213+01: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": "509"
}
},
"company": {
"data": {
"type": "companies",
"id": "1977"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1413"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "1977",
"type": "companies",
"attributes": {
"name": "Client1469",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:58.211+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "509"
}
}
}
},
{
"id": "1413",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1398@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:05:58.000+01:00",
"is_user": true,
"user_id": 1422,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:05:58.186+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "509"
}
},
"company": {
"data": {
"type": "companies",
"id": "1976"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "1976",
"type": "companies",
"attributes": {
"name": "Client1468",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:58.183+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "509"
}
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/pages?filter%5Bproject_id%5D=295&page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/pages?filter%5Bproject_id%5D=295&page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 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
},
"workflows": {
"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
},
"time_off_sync": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}Get pagesGET/api/v2/pages
GET /api/v2/pages/1
Requests
GET /api/v2/pages/16
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": "16",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:05:58.489+01:00",
"updated_at": "2021-12-06T00:05:58.489+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "510"
}
},
"project": {
"data": {
"type": "projects",
"id": "296"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
"included": [
{
"id": "296",
"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-12-06T00:05:58.427+01: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": "510"
}
},
"company": {
"data": {
"type": "companies",
"id": "1981"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1416"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "1981",
"type": "companies",
"attributes": {
"name": "Client1472",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:58.425+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "510"
}
}
}
},
{
"id": "1416",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1401@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:05:58.000+01:00",
"is_user": true,
"user_id": 1425,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:05:58.395+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "510"
}
},
"company": {
"data": {
"type": "companies",
"id": "1980"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "1980",
"type": "companies",
"attributes": {
"name": "Client1471",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:58.391+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "510"
}
}
}
}
],
"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
},
"workflows": {
"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
},
"time_off_sync": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}POST /api/v2/pages
Requests
POST /api/v2/pages
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": "pages",
"attributes": {
"title": "test name",
"body": "test body"
},
"relationships": {
"project": {
"data": {
"type": "projects",
"id": "297"
}
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "18",
"type": "pages",
"attributes": {
"title": "test name",
"body": "test body",
"created_at": "2021-12-06T00:05:58.704+01:00",
"updated_at": "2021-12-06T00:05:58.704+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "511"
}
},
"project": {
"data": {
"type": "projects",
"id": "297"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
"included": [
{
"id": "297",
"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-12-06T00:05:58.620+01: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": "511"
}
},
"company": {
"data": {
"type": "companies",
"id": "1985"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1419"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "1985",
"type": "companies",
"attributes": {
"name": "Client1475",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:58.618+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "511"
}
}
}
},
{
"id": "1419",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1404@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:05:58.000+01:00",
"is_user": true,
"user_id": 1428,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:05:58.589+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "511"
}
},
"company": {
"data": {
"type": "companies",
"id": "1984"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "1984",
"type": "companies",
"attributes": {
"name": "Client1474",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:58.585+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "511"
}
}
}
}
],
"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
},
"workflows": {
"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
},
"time_off_sync": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}POST /api/v2/pages
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": "pages",
"attributes": {
"title": ""
}
}
}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/title"
}
}
]
}Create a pagePOST/api/v2/pages
URI Parameters
- title
string(required) Example: Titletitle
- project_id
number(required) Example: 1project id
PATCH /api/v2/pages/1
Requests
PATCH /api/v2/pages/20
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": "pages",
"attributes": {
"title": "new title"
},
"relationships": {
"subscribers": {
"data": [
{
"type": "people",
"id": "1428"
},
{
"type": "people",
"id": "1429"
}
]
},
"attachments": {
"data": [
{
"type": "attachments",
"id": "14"
}
]
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "20",
"type": "pages",
"attributes": {
"title": "new title",
"body": "Page body",
"created_at": "2021-12-06T00:05:59.084+01:00",
"updated_at": "2021-12-06T00:05:59.302+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "513"
}
},
"project": {
"data": {
"type": "projects",
"id": "299"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
"included": [
{
"id": "299",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-12-06T00:05:59.026+01: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": "513"
}
},
"company": {
"data": {
"type": "companies",
"id": "1993"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1425"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "1993",
"type": "companies",
"attributes": {
"name": "Client1481",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:59.019+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "513"
}
}
}
},
{
"id": "1425",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1410@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:05:58.000+01:00",
"is_user": true,
"user_id": 1434,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:05:58.989+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "513"
}
},
"company": {
"data": {
"type": "companies",
"id": "1992"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "1992",
"type": "companies",
"attributes": {
"name": "Client1480",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:58.967+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "513"
}
}
}
}
],
"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
},
"workflows": {
"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
},
"time_off_sync": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/pages/21
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": "pages",
"attributes": {
"title": ""
}
}
}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/title"
}
}
]
}PATCH /api/v2/pages/23
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": "pages",
"attributes": {
"root_page_id": 24,
"parent_page_id": 25
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "23",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:05:59.840+01:00",
"updated_at": "2021-12-06T00:06:00.083+01:00",
"root_page_id": 24,
"parent_page_id": 25,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "515"
}
},
"project": {
"data": {
"type": "projects",
"id": "301"
}
},
"root_page": {
"data": {
"type": "pages",
"id": "24"
}
},
"parent_page": {
"data": {
"type": "pages",
"id": "25"
}
},
"attachments": {
"data": []
}
}
},
"included": [
{
"id": "301",
"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-12-06T00:05:59.678+01: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": "515"
}
},
"company": {
"data": {
"type": "companies",
"id": "2004"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1434"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "24",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:05:59.936+01:00",
"updated_at": "2021-12-06T00:05:59.936+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "515"
}
},
"project": {
"data": {
"type": "projects",
"id": "303"
}
},
"root_page": {
"meta": {
"included": false
}
},
"parent_page": {
"meta": {
"included": false
}
},
"attachments": {
"data": []
}
}
},
{
"id": "25",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:06:00.046+01:00",
"updated_at": "2021-12-06T00:06:00.046+01:00",
"root_page_id": 24,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "515"
}
},
"project": {
"data": {
"type": "projects",
"id": "304"
}
},
"root_page": {
"meta": {
"included": false
}
},
"parent_page": {
"meta": {
"included": false
}
},
"attachments": {
"data": []
}
}
},
{
"id": "2004",
"type": "companies",
"attributes": {
"name": "Client1490",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:59.675+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "515"
}
}
}
},
{
"id": "1434",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1419@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:05:59.000+01:00",
"is_user": true,
"user_id": 1443,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:05:59.643+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "515"
}
},
"company": {
"data": {
"type": "companies",
"id": "2003"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "303",
"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-12-06T00:05:59.885+01: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": "515"
}
},
"company": {
"data": {
"type": "companies",
"id": "2010"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1438"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "304",
"type": "projects",
"attributes": {
"name": "test project",
"number": 4,
"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-12-06T00:05:59.987+01: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": "515"
}
},
"company": {
"data": {
"type": "companies",
"id": "2013"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1440"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "2003",
"type": "companies",
"attributes": {
"name": "Client1489",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:59.638+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "515"
}
}
}
},
{
"id": "2010",
"type": "companies",
"attributes": {
"name": "Client1496",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:59.882+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "515"
}
}
}
},
{
"id": "1438",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1423@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:05:59.000+01:00",
"is_user": true,
"user_id": 1447,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:05:59.856+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "515"
}
},
"company": {
"data": {
"type": "companies",
"id": "2009"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2013",
"type": "companies",
"attributes": {
"name": "Client1499",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:59.984+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "515"
}
}
}
},
{
"id": "1440",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1425@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:05:59.000+01:00",
"is_user": true,
"user_id": 1449,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:05:59.954+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "515"
}
},
"company": {
"data": {
"type": "companies",
"id": "2012"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2009",
"type": "companies",
"attributes": {
"name": "Client1495",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:59.852+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "515"
}
}
}
},
{
"id": "2012",
"type": "companies",
"attributes": {
"name": "Client1498",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:59.949+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "515"
}
}
}
}
],
"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
},
"workflows": {
"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
},
"time_off_sync": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/pages/27
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": "pages",
"attributes": {
"root_page_id": 28,
"parent_page_id": 29
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "attribute is invalid",
"source": {
"pointer": "data/attributes/parent_page"
}
}
]
}PATCH /api/v2/pages/30
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": "pages",
"attributes": {
"root_page_id": 31
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "30",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:06:00.782+01:00",
"updated_at": "2021-12-06T00:06:00.908+01:00",
"root_page_id": 31,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "517"
}
},
"project": {
"data": {
"type": "projects",
"id": "309"
}
},
"root_page": {
"data": {
"type": "pages",
"id": "31"
}
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
"included": [
{
"id": "309",
"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-12-06T00:06:00.730+01: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": "517"
}
},
"company": {
"data": {
"type": "companies",
"id": "2030"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1452"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "31",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:06:00.878+01:00",
"updated_at": "2021-12-06T00:06:00.878+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "517"
}
},
"project": {
"data": {
"type": "projects",
"id": "310"
}
},
"root_page": {
"meta": {
"included": false
}
},
"parent_page": {
"meta": {
"included": false
}
},
"attachments": {
"data": []
}
}
},
{
"id": "2030",
"type": "companies",
"attributes": {
"name": "Client1514",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:00.727+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "517"
}
}
}
},
{
"id": "1452",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1437@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:06:00.000+01:00",
"is_user": true,
"user_id": 1461,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:06:00.699+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "517"
}
},
"company": {
"data": {
"type": "companies",
"id": "2029"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "310",
"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-12-06T00:06:00.827+01: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": "517"
}
},
"company": {
"data": {
"type": "companies",
"id": "2033"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1454"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "2029",
"type": "companies",
"attributes": {
"name": "Client1513",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:00.696+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "517"
}
}
}
},
{
"id": "2033",
"type": "companies",
"attributes": {
"name": "Client1517",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:00.825+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "517"
}
}
}
},
{
"id": "1454",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1439@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:06:00.000+01:00",
"is_user": true,
"user_id": 1463,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:06:00.798+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "517"
}
},
"company": {
"data": {
"type": "companies",
"id": "2032"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2032",
"type": "companies",
"attributes": {
"name": "Client1516",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:00.794+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "517"
}
}
}
}
],
"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
},
"workflows": {
"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
},
"time_off_sync": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/pages/32
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": "pages",
"attributes": {
"root_page_id": 33
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "attribute is invalid",
"source": {
"pointer": "data/attributes/root_page"
}
}
]
}PATCH /api/v2/pages/35
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": "pages",
"attributes": {
"parent_page_id": 36
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "35",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:06:01.592+01:00",
"updated_at": "2021-12-06T00:06:01.734+01:00",
"root_page_id": 34,
"parent_page_id": 36,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "519"
}
},
"project": {
"data": {
"type": "projects",
"id": "313"
}
},
"root_page": {
"data": {
"type": "pages",
"id": "34"
}
},
"parent_page": {
"data": {
"type": "pages",
"id": "36"
}
},
"attachments": {
"data": []
}
}
},
"included": [
{
"id": "313",
"type": "projects",
"attributes": {
"name": "test project",
"number": 1,
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": null,
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2021-12-06T00:06:01.434+01: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": "519"
}
},
"company": {
"data": {
"type": "companies",
"id": "2044"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1462"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "34",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:06:01.551+01:00",
"updated_at": "2021-12-06T00:06:01.551+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "519"
}
},
"project": {
"data": {
"type": "projects",
"id": "314"
}
},
"root_page": {
"meta": {
"included": false
}
},
"parent_page": {
"meta": {
"included": false
}
},
"attachments": {
"data": []
}
}
},
{
"id": "36",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:06:01.697+01:00",
"updated_at": "2021-12-06T00:06:01.697+01:00",
"root_page_id": 34,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "519"
}
},
"project": {
"data": {
"type": "projects",
"id": "315"
}
},
"root_page": {
"meta": {
"included": false
}
},
"parent_page": {
"meta": {
"included": false
}
},
"attachments": {
"data": []
}
}
},
{
"id": "2044",
"type": "companies",
"attributes": {
"name": "Client1526",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:01.432+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "519"
}
}
}
},
{
"id": "1462",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1447@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:06:01.000+01:00",
"is_user": true,
"user_id": 1471,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:06:01.400+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "519"
}
},
"company": {
"data": {
"type": "companies",
"id": "2043"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "314",
"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-12-06T00:06:01.497+01: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": "519"
}
},
"company": {
"data": {
"type": "companies",
"id": "2046"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1463"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "315",
"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-12-06T00:06:01.640+01: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": "519"
}
},
"company": {
"data": {
"type": "companies",
"id": "2050"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1466"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "2043",
"type": "companies",
"attributes": {
"name": "Client1525",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:01.395+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "519"
}
}
}
},
{
"id": "2046",
"type": "companies",
"attributes": {
"name": "Client1528",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:01.494+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "519"
}
}
}
},
{
"id": "1463",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1448@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:06:01.000+01:00",
"is_user": true,
"user_id": 1472,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:06:01.466+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "519"
}
},
"company": {
"data": {
"type": "companies",
"id": "2045"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2050",
"type": "companies",
"attributes": {
"name": "Client1532",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:01.638+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "519"
}
}
}
},
{
"id": "1466",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1451@email.com",
"title": null,
"joined_at": null,
"last_seen_at": null,
"deactivated_at": null,
"archived_at": null,
"role_id": 3,
"setting_role_id": null,
"invited_at": "2021-12-06T00:06:01.000+01:00",
"is_user": true,
"user_id": 1475,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:06:01.611+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "519"
}
},
"company": {
"data": {
"type": "companies",
"id": "2049"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2045",
"type": "companies",
"attributes": {
"name": "Client1527",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:01.462+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "519"
}
}
}
},
{
"id": "2049",
"type": "companies",
"attributes": {
"name": "Client1531",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:01.604+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "519"
}
}
}
}
],
"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
},
"workflows": {
"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
},
"time_off_sync": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}PATCH /api/v2/pages/38
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": "pages",
"attributes": {
"parent_page_id": 40
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "attribute is invalid",
"source": {
"pointer": "data/attributes/parent_page"
}
}
]
}DELETE /api/v2/pages/1
Requests
DELETE /api/v2/pages/41
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.
Generated by aglio on 05 Dec 2021