API Documentation
Discussions ¶
Discussions ¶
Discussion is a thread of comments related to the highlighted part of docs (page) content.
Supported filter params
- page_id
GET /api/v2/discussions
Requests
GET /api/v2/discussions
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": "1",
"type": "discussions",
"attributes": {
"resolved_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "261"
}
},
"page": {
"data": {
"type": "pages",
"id": "1"
}
}
}
},
{
"id": "2",
"type": "discussions",
"attributes": {
"resolved_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "261"
}
},
"page": {
"data": {
"type": "pages",
"id": "3"
}
}
}
},
{
"id": "3",
"type": "discussions",
"attributes": {
"resolved_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "261"
}
},
"page": {
"data": {
"type": "pages",
"id": "4"
}
}
}
}
],
"included": [
{
"id": "1",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:04:58.051+01:00",
"updated_at": "2021-12-06T00:04:58.051+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "261"
}
},
"project": {
"data": {
"type": "projects",
"id": "121"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "3",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:04:58.280+01:00",
"updated_at": "2021-12-06T00:04:58.280+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "261"
}
},
"project": {
"data": {
"type": "projects",
"id": "123"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "4",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:04:58.392+01:00",
"updated_at": "2021-12-06T00:04:58.392+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "261"
}
},
"project": {
"data": {
"type": "projects",
"id": "124"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "121",
"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:04:57.997+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": "261"
}
},
"company": {
"data": {
"type": "companies",
"id": "958"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "712"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "123",
"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:04:58.223+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": "261"
}
},
"company": {
"data": {
"type": "companies",
"id": "964"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "716"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "124",
"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:04:58.334+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": "261"
}
},
"company": {
"data": {
"type": "companies",
"id": "967"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "718"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "958",
"type": "companies",
"attributes": {
"name": "Client696",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:04:57.994+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": "261"
}
}
}
},
{
"id": "712",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user713@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:04:57.000+01:00",
"is_user": true,
"user_id": 713,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:04:57.963+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "261"
}
},
"company": {
"data": {
"type": "companies",
"id": "957"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "964",
"type": "companies",
"attributes": {
"name": "Client702",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:04:58.220+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": "261"
}
}
}
},
{
"id": "716",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user717@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:04:58.000+01:00",
"is_user": true,
"user_id": 717,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:04:58.190+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "261"
}
},
"company": {
"data": {
"type": "companies",
"id": "963"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "967",
"type": "companies",
"attributes": {
"name": "Client705",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:04:58.331+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": "261"
}
}
}
},
{
"id": "718",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user719@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:04:58.000+01:00",
"is_user": true,
"user_id": 719,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:04:58.301+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "261"
}
},
"company": {
"data": {
"type": "companies",
"id": "966"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "957",
"type": "companies",
"attributes": {
"name": "Client695",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:04:57.958+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": "261"
}
}
}
},
{
"id": "963",
"type": "companies",
"attributes": {
"name": "Client701",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:04:58.185+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": "261"
}
}
}
},
{
"id": "966",
"type": "companies",
"attributes": {
"name": "Client704",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:04:58.296+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": "261"
}
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/discussions?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/discussions?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
},
"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 /api/v2/discussions
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": "10",
"type": "discussions",
"attributes": {
"resolved_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "658"
}
},
"page": {
"data": {
"type": "pages",
"id": "42"
}
}
}
},
{
"id": "11",
"type": "discussions",
"attributes": {
"resolved_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "658"
}
},
"page": {
"data": {
"type": "pages",
"id": "44"
}
}
}
},
{
"id": "12",
"type": "discussions",
"attributes": {
"resolved_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "658"
}
},
"page": {
"data": {
"type": "pages",
"id": "45"
}
}
}
}
],
"included": [
{
"id": "42",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:06:27.791+01:00",
"updated_at": "2021-12-06T00:06:27.791+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "658"
}
},
"project": {
"data": {
"type": "projects",
"id": "355"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "44",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:06:28.020+01:00",
"updated_at": "2021-12-06T00:06:28.020+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "658"
}
},
"project": {
"data": {
"type": "projects",
"id": "357"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "45",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:06:28.120+01:00",
"updated_at": "2021-12-06T00:06:28.120+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "658"
}
},
"project": {
"data": {
"type": "projects",
"id": "358"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "355",
"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:27.743+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": "658"
}
},
"company": {
"data": {
"type": "companies",
"id": "2401"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1788"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "357",
"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:27.961+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": "658"
}
},
"company": {
"data": {
"type": "companies",
"id": "2407"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1792"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "358",
"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:06:28.069+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": "658"
}
},
"company": {
"data": {
"type": "companies",
"id": "2410"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1794"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "2401",
"type": "companies",
"attributes": {
"name": "Client1744",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:27.741+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": "658"
}
}
}
},
{
"id": "1788",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1737@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:27.000+01:00",
"is_user": true,
"user_id": 1778,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:06:27.714+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "658"
}
},
"company": {
"data": {
"type": "companies",
"id": "2400"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2407",
"type": "companies",
"attributes": {
"name": "Client1750",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:27.958+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": "658"
}
}
}
},
{
"id": "1792",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1741@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:27.000+01:00",
"is_user": true,
"user_id": 1782,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:06:27.924+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "658"
}
},
"company": {
"data": {
"type": "companies",
"id": "2406"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2410",
"type": "companies",
"attributes": {
"name": "Client1753",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:28.067+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": "658"
}
}
}
},
{
"id": "1794",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1743@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:28.000+01:00",
"is_user": true,
"user_id": 1784,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:06:28.039+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "658"
}
},
"company": {
"data": {
"type": "companies",
"id": "2409"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2400",
"type": "companies",
"attributes": {
"name": "Client1743",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:27.710+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": "658"
}
}
}
},
{
"id": "2406",
"type": "companies",
"attributes": {
"name": "Client1749",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:27.919+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": "658"
}
}
}
},
{
"id": "2409",
"type": "companies",
"attributes": {
"name": "Client1752",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:28.035+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": "658"
}
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/discussions?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/discussions?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
},
"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 discussionsGET/api/v2/discussions
GET /api/v2/discussions/1
Requests
GET /api/v2/discussions/4
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": "4",
"type": "discussions",
"attributes": {
"resolved_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "262"
}
},
"page": {
"data": {
"type": "pages",
"id": "5"
}
}
}
},
"included": [
{
"id": "5",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:04:58.635+01:00",
"updated_at": "2021-12-06T00:04:58.635+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "262"
}
},
"project": {
"data": {
"type": "projects",
"id": "125"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "125",
"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:04:58.586+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": "262"
}
},
"company": {
"data": {
"type": "companies",
"id": "971"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "721"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "971",
"type": "companies",
"attributes": {
"name": "Client708",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:04:58.583+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": "262"
}
}
}
},
{
"id": "721",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user722@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:04:58.000+01:00",
"is_user": true,
"user_id": 722,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:04:58.551+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "262"
}
},
"company": {
"data": {
"type": "companies",
"id": "970"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "970",
"type": "companies",
"attributes": {
"name": "Client707",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:04:58.547+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": "262"
}
}
}
}
],
"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": {}
}
}GET /api/v2/discussions/13
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": "13",
"type": "discussions",
"attributes": {
"resolved_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "659"
}
},
"page": {
"data": {
"type": "pages",
"id": "46"
}
}
}
},
"included": [
{
"id": "46",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:06:28.334+01:00",
"updated_at": "2021-12-06T00:06:28.334+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "659"
}
},
"project": {
"data": {
"type": "projects",
"id": "359"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "359",
"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:28.284+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": "659"
}
},
"company": {
"data": {
"type": "companies",
"id": "2414"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1797"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "2414",
"type": "companies",
"attributes": {
"name": "Client1756",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:28.281+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": "659"
}
}
}
},
{
"id": "1797",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1746@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:28.000+01:00",
"is_user": true,
"user_id": 1787,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:06:28.252+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "659"
}
},
"company": {
"data": {
"type": "companies",
"id": "2413"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2413",
"type": "companies",
"attributes": {
"name": "Client1755",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:28.248+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": "659"
}
}
}
}
],
"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": {}
}
}Gets a discussionGET/api/v2/discussions/{id}
URI Parameters
- id
number(required) Example: 1discussion id
POST /api/v2/discussions
Requests
POST /api/v2/discussions
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": "discussions",
"attributes": {},
"relationships": {
"page": {
"data": {
"type": "pages",
"id": "8"
}
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "6",
"type": "discussions",
"attributes": {
"resolved_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "263"
}
},
"page": {
"data": {
"type": "pages",
"id": "8"
}
}
}
},
"included": [
{
"id": "8",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:04:59.298+01:00",
"updated_at": "2021-12-06T00:04:59.298+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "263"
}
},
"project": {
"data": {
"type": "projects",
"id": "128"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "128",
"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:04:59.121+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": "263"
}
},
"company": {
"data": {
"type": "companies",
"id": "981"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "728"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "981",
"type": "companies",
"attributes": {
"name": "Client717",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:04:59.118+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": "263"
}
}
}
},
{
"id": "728",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user729@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:04:59.000+01:00",
"is_user": true,
"user_id": 729,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:04:59.085+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "263"
}
},
"company": {
"data": {
"type": "companies",
"id": "980"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "980",
"type": "companies",
"attributes": {
"name": "Client716",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:04:59.080+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": "263"
}
}
}
}
],
"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/discussions
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": "discussions",
"attributes": {},
"relationships": {
"page": {
"data": {
"type": "pages",
"id": ""
}
}
}
}
}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/page"
}
}
]
}POST /api/v2/discussions
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": "discussions",
"attributes": {},
"relationships": {
"page": {
"data": {
"type": "pages",
"id": "49"
}
}
}
}
}Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "15",
"type": "discussions",
"attributes": {
"resolved_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "660"
}
},
"page": {
"data": {
"type": "pages",
"id": "49"
}
}
}
},
"included": [
{
"id": "49",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:06:28.991+01:00",
"updated_at": "2021-12-06T00:06:28.991+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "660"
}
},
"project": {
"data": {
"type": "projects",
"id": "362"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "362",
"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:28.808+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": "660"
}
},
"company": {
"data": {
"type": "companies",
"id": "2424"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1804"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "2424",
"type": "companies",
"attributes": {
"name": "Client1765",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:28.805+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": "660"
}
}
}
},
{
"id": "1804",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1753@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:28.000+01:00",
"is_user": true,
"user_id": 1794,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:06:28.780+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "660"
}
},
"company": {
"data": {
"type": "companies",
"id": "2423"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2423",
"type": "companies",
"attributes": {
"name": "Client1764",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:28.776+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": "660"
}
}
}
}
],
"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/discussions
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": "discussions",
"attributes": {},
"relationships": {
"page": {
"data": {
"type": "pages",
"id": ""
}
}
}
}
}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/page"
}
}
]
}DELETE /api/v2/discussions/1
Requests
DELETE /api/v2/discussions/8
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/discussions/17
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
This response has no content.
Deletes a discussionDELETE/api/v2/discussions/{id}
URI Parameters
- id
number(required) Example: 1discussion id
PATCH /api/v2/discussions/1/resolve
Requests
PATCH /api/v2/discussions/9/resolve
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": "9",
"type": "discussions",
"attributes": {
"resolved_at": "2021-12-06T00:05:01.000+01:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "266"
}
},
"page": {
"data": {
"type": "pages",
"id": "13"
}
}
}
},
"included": [
{
"id": "13",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:05:00.764+01:00",
"updated_at": "2021-12-06T00:05:00.764+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "266"
}
},
"project": {
"data": {
"type": "projects",
"id": "133"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "133",
"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:00.580+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": "266"
}
},
"company": {
"data": {
"type": "companies",
"id": "999"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "741"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "999",
"type": "companies",
"attributes": {
"name": "Client732",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:00.577+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": "266"
}
}
}
},
{
"id": "741",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user742@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:00.000+01:00",
"is_user": true,
"user_id": 742,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:05:00.547+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "266"
}
},
"company": {
"data": {
"type": "companies",
"id": "998"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "998",
"type": "companies",
"attributes": {
"name": "Client731",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:05:00.543+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": "266"
}
}
}
}
],
"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/discussions/18/resolve
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": "18",
"type": "discussions",
"attributes": {
"resolved_at": "2021-12-06T00:06:30.000+01:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "663"
}
},
"page": {
"data": {
"type": "pages",
"id": "54"
}
}
}
},
"included": [
{
"id": "54",
"type": "pages",
"attributes": {
"title": "Page title",
"body": "Page body",
"created_at": "2021-12-06T00:06:30.409+01:00",
"updated_at": "2021-12-06T00:06:30.409+01:00",
"root_page_id": null,
"parent_page_id": null,
"position": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "663"
}
},
"project": {
"data": {
"type": "projects",
"id": "367"
}
},
"root_page": {
"data": null
},
"parent_page": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "367",
"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:30.252+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": "663"
}
},
"company": {
"data": {
"type": "companies",
"id": "2442"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "1817"
}
},
"last_actor": {
"data": null
},
"workflow": {
"data": null
}
}
},
{
"id": "2442",
"type": "companies",
"attributes": {
"name": "Client1780",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:30.249+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": "663"
}
}
}
},
{
"id": "1817",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1766@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:30.000+01:00",
"is_user": true,
"user_id": 1807,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-12-06T00:06:30.222+01:00",
"placeholder": false,
"color_id": null,
"contact": {},
"sample_data": false,
"last_activity_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "663"
}
},
"company": {
"data": {
"type": "companies",
"id": "2441"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
}
}
},
{
"id": "2441",
"type": "companies",
"attributes": {
"name": "Client1779",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-12-06T00:06:30.218+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": "663"
}
}
}
}
],
"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": {}
}
}Resolves a discussionPATCH/api/v2/discussions/{id}/resolve
URI Parameters
- id
number(required) Example: 1discussion id
Generated by aglio on 05 Dec 2021