API Documentation
Comments ¶
GET /api/v2/comments/1
Requests
GET /api/v2/comments/10
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "10",
"type": "comments",
"attributes": {
"commentable_type": "company",
"body": "blah",
"created_at": "2021-01-24T00:03:40.313+01:00",
"pinned_at": null,
"edited_at": null,
"deleted_at": null,
"reactions": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 121
}
},
"creator": {
"data": {
"type": "people",
"id": "338"
}
},
"pinned_by": {
"data": null
},
"person": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "411"
}
},
"deal": {
"data": null
},
"task": {
"data": null
},
"invoice": {
"data": null
},
"attachments": {
"data": []
}
}
},
"included": [
{
"id": "338",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user340@email.com",
"title": null,
"joined_at": "2021-01-24T00:03:40.000+01:00",
"last_seen_at": "2021-01-24T00:03:40.329+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:03:40.269+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 121
}
},
"company": {
"data": {
"type": "companies",
"id": "409"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "411",
"type": "companies",
"attributes": {
"name": "Client290",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:03:40.310+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 121
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "409",
"type": "companies",
"attributes": {
"name": "Organization121",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:03:40.267+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 121
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/comments
Requests
POST /api/v2/comments
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "comments",
"attributes": {
"commentable_type": "task"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "12",
"type": "comments",
"attributes": {
"commentable_type": "task",
"body": null,
"created_at": "2021-01-24T00:03:40.460+01:00",
"pinned_at": null,
"edited_at": null,
"deleted_at": null,
"reactions": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 122
}
},
"creator": {
"data": {
"type": "people",
"id": "339"
}
},
"pinned_by": {
"data": null
},
"person": {
"data": null
},
"company": {
"data": null
},
"deal": {
"data": null
},
"task": {
"data": null
},
"invoice": {
"data": null
},
"attachments": {
"data": []
}
}
},
"included": [
{
"id": "339",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user341@email.com",
"title": null,
"joined_at": "2021-01-24T00:03:40.000+01:00",
"last_seen_at": "2021-01-24T00:03:40.453+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:03:40.396+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 122
}
},
"company": {
"data": {
"type": "companies",
"id": "412"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "412",
"type": "companies",
"attributes": {
"name": "Organization122",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:03:40.395+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 122
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/comments
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "comments",
"attributes": {
"commentable_type": "invalid"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not included in the list",
"source": {
"pointer": "data/attributes/commentable_type"
}
}
]
}
Create a commentPOST/api/v2/comments
PATCH /api/v2/comments/1
Requests
PATCH /api/v2/comments/14
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "comments",
"attributes": {
"body": "new body"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "14",
"type": "comments",
"attributes": {
"commentable_type": "task",
"body": "new body",
"created_at": "2021-01-24T00:03:40.670+01:00",
"pinned_at": null,
"edited_at": "2021-01-24T00:03:40.716+01:00",
"deleted_at": null,
"reactions": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 124
}
},
"creator": {
"data": {
"type": "people",
"id": "341"
}
},
"pinned_by": {
"data": null
},
"person": {
"data": null
},
"company": {
"data": null
},
"deal": {
"data": null
},
"task": {
"data": {
"type": "tasks",
"id": "13"
}
},
"invoice": {
"data": null
},
"attachments": {
"data": []
}
}
},
"included": [
{
"id": "341",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user343@email.com",
"title": null,
"joined_at": "2021-01-24T00:03:40.000+01:00",
"last_seen_at": "2021-01-24T00:03:40.702+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:03:40.610+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 124
}
},
"company": {
"data": {
"type": "companies",
"id": "418"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "13",
"type": "tasks",
"attributes": {
"title": "Ticket title",
"description": null,
"number": 1,
"private": false,
"due_date": null,
"start_date": null,
"closed_at": null,
"created_at": "2021-01-24T00:03:40.661+01:00",
"updated_at": "2021-01-24T00:03:40.718+01:00",
"repeat_schedule_id": null,
"repeat_on_interval": null,
"repeat_on_monthday": null,
"repeat_on_weekday": [],
"repeat_on_date": null,
"repeat_origin_id": null,
"email_key": "d4cc4cd4ca29e2ea8e162e64a0b4e3cb",
"custom_fields": null,
"todo_count": null,
"open_todo_count": null,
"todo_assignee_count": null,
"subtask_count": null,
"open_subtask_count": null,
"creation_method_id": 1,
"subtask_position": null,
"closed": false,
"due_time": null,
"tag_list": [],
"position": 1,
"last_activity_at": null,
"initial_estimate": null,
"remaining_time": null,
"worked_time": null,
"deleted_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 124
}
},
"project": {
"data": {
"type": "projects",
"id": "58"
}
},
"creator": {
"data": {
"type": "people",
"id": "341"
}
},
"assignee": {
"data": null
},
"last_actor": {
"data": null
},
"task_list": {
"data": {
"type": "task_lists",
"id": "17"
}
},
"parent_task": {
"data": null
},
"attachments": {
"data": []
}
}
},
{
"id": "418",
"type": "companies",
"attributes": {
"name": "Organization124",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:03:40.609+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 124
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "58",
"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-01-24T00:03:40.634+01:00",
"board_count": 1,
"budget_count": 0,
"worked_time": 0,
"estimated_time": 0,
"profit_margin": 0,
"budget_closing_date": null,
"invoice_payment_due": null,
"custom_fields": null,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"needs_invoicing": 0,
"needs_invoicing_default": 0,
"needs_invoicing_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 124
}
},
"company": {
"data": {
"type": "companies",
"id": "419"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "341"
}
},
"last_actor": {
"data": null
}
}
},
{
"id": "17",
"type": "task_lists",
"attributes": {
"name": "Milestone15",
"position": 1,
"archived_at": null,
"email_key": "0b3e459b6ba9ef7da52bb9a0db12d733"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 124
}
},
"project": {
"data": {
"type": "projects",
"id": "58"
}
},
"board": {
"data": {
"type": "boards",
"id": "32"
}
}
}
},
{
"id": "419",
"type": "companies",
"attributes": {
"name": "Client295",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:03:40.631+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 124
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "32",
"type": "boards",
"attributes": {
"name": "Board14",
"position": 1,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 124
}
},
"project": {
"data": {
"type": "projects",
"id": "58"
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCH /api/v2/comments/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+json
Body
{
"data": {
"type": "comments",
"attributes": {
"body": "new body"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "16",
"type": "comments",
"attributes": {
"commentable_type": "company",
"body": "new body",
"created_at": "2021-01-24T00:03:41.150+01:00",
"pinned_at": null,
"edited_at": "2021-01-24T00:03:41.173+01:00",
"deleted_at": null,
"reactions": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 126
}
},
"creator": {
"data": {
"type": "people",
"id": "343"
}
},
"pinned_by": {
"data": null
},
"person": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "426"
}
},
"deal": {
"data": null
},
"task": {
"data": null
},
"invoice": {
"data": null
},
"attachments": {
"data": []
}
}
},
"included": [
{
"id": "343",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user345@email.com",
"title": null,
"joined_at": "2021-01-24T00:03:41.000+01:00",
"last_seen_at": "2021-01-24T00:03:41.164+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:03:41.108+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 126
}
},
"company": {
"data": {
"type": "companies",
"id": "424"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "426",
"type": "companies",
"attributes": {
"name": "Client300",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:03:41.147+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 126
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "424",
"type": "companies",
"attributes": {
"name": "Organization126",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:03:41.106+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 126
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCH /api/v2/comments/1/pin
Requests
PATCH /api/v2/comments/18/pin
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "18",
"type": "comments",
"attributes": {
"commentable_type": "company",
"body": "blah",
"created_at": "2021-01-24T00:03:41.404+01:00",
"pinned_at": "2021-01-24T00:03:41.000+01:00",
"edited_at": null,
"deleted_at": null,
"reactions": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 128
}
},
"creator": {
"data": {
"type": "people",
"id": "345"
}
},
"pinned_by": {
"data": {
"type": "people",
"id": "345"
}
},
"person": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "432"
}
},
"deal": {
"data": null
},
"task": {
"data": null
},
"invoice": {
"data": null
},
"attachments": {
"data": []
}
}
},
"included": [
{
"id": "345",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user347@email.com",
"title": null,
"joined_at": "2021-01-24T00:03:41.000+01:00",
"last_seen_at": "2021-01-24T00:03:41.416+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:03:41.365+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 128
}
},
"company": {
"data": {
"type": "companies",
"id": "430"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "432",
"type": "companies",
"attributes": {
"name": "Client304",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:03:41.402+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 128
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "430",
"type": "companies",
"attributes": {
"name": "Organization128",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:03:41.364+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 128
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCH /api/v2/comments/19/pin
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "403",
"title": "Access Denied",
"detail": "You are not authorized to access this resource",
"source": {
"pointer": null
}
}
]
}
PATCH /api/v2/comments/1/unpin
Requests
PATCH /api/v2/comments/20/unpin
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "20",
"type": "comments",
"attributes": {
"commentable_type": "company",
"body": "blah",
"created_at": "2021-01-24T00:03:41.612+01:00",
"pinned_at": null,
"edited_at": null,
"deleted_at": null,
"reactions": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 130
}
},
"creator": {
"data": {
"type": "people",
"id": "347"
}
},
"pinned_by": {
"data": null
},
"person": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "438"
}
},
"deal": {
"data": null
},
"task": {
"data": null
},
"invoice": {
"data": null
},
"attachments": {
"data": []
}
}
},
"included": [
{
"id": "347",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user349@email.com",
"title": null,
"joined_at": "2021-01-24T00:03:41.000+01:00",
"last_seen_at": "2021-01-24T00:03:41.628+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:03:41.571+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 130
}
},
"company": {
"data": {
"type": "companies",
"id": "436"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "438",
"type": "companies",
"attributes": {
"name": "Client308",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:03:41.609+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 130
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "436",
"type": "companies",
"attributes": {
"name": "Organization130",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:03:41.570+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 130
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCH /api/v2/comments/21/unpin
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "403",
"title": "Access Denied",
"detail": "You are not authorized to access this resource",
"source": {
"pointer": null
}
}
]
}
Unpins a commentPATCH/api/v2/comments/{id}/unpin
URI Parameters
- id
number
(required) Example: 1comment id
DELETE /api/v2/comments/1
Requests
DELETE /api/v2/comments/22
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
This response has no content.
DELETE /api/v2/comments/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+json
Responses
This response has no content.
PATCH /api/v2/comments/1/add_reaction
Requests
PATCH /api/v2/comments/24/add_reaction
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "comments",
"attributes": {
"reaction": "like"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "24",
"type": "comments",
"attributes": {
"commentable_type": "company",
"body": "blah",
"created_at": "2021-01-24T00:03:42.086+01:00",
"pinned_at": null,
"edited_at": null,
"deleted_at": null,
"reactions": {
"like": {
"people": [
"351"
],
"created_at": "2021-01-24T00:03:42.105+01:00"
}
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 134
}
},
"creator": {
"data": {
"type": "people",
"id": "351"
}
},
"pinned_by": {
"data": null
},
"person": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "450"
}
},
"deal": {
"data": null
},
"task": {
"data": null
},
"invoice": {
"data": null
},
"attachments": {
"data": []
}
}
},
"included": [
{
"id": "351",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user353@email.com",
"title": null,
"joined_at": "2021-01-24T00:03:42.000+01:00",
"last_seen_at": "2021-01-24T00:03:42.099+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:03:42.044+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 134
}
},
"company": {
"data": {
"type": "companies",
"id": "448"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "450",
"type": "companies",
"attributes": {
"name": "Client316",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:03:42.083+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 134
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "448",
"type": "companies",
"attributes": {
"name": "Organization134",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:03:42.043+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 134
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Adds reaction to a commentPATCH/api/v2/comments/{id}/add_reaction
URI Parameters
- id
number
(required) Example: 1comment id
PATCH /api/v2/comments/1/remove_reaction
Requests
PATCH /api/v2/comments/26/remove_reaction
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "comments",
"attributes": {
"reaction": "like"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "26",
"type": "comments",
"attributes": {
"commentable_type": "company",
"body": "blah",
"created_at": "2021-01-24T00:03:42.298+01:00",
"pinned_at": null,
"edited_at": null,
"deleted_at": null,
"reactions": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 136
}
},
"creator": {
"data": {
"type": "people",
"id": "353"
}
},
"pinned_by": {
"data": null
},
"person": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "456"
}
},
"deal": {
"data": null
},
"task": {
"data": null
},
"invoice": {
"data": null
},
"attachments": {
"data": []
}
}
},
"included": [
{
"id": "353",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user355@email.com",
"title": null,
"joined_at": "2021-01-24T00:03:42.000+01:00",
"last_seen_at": "2021-01-24T00:03:42.314+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:03:42.259+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 136
}
},
"company": {
"data": {
"type": "companies",
"id": "454"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "456",
"type": "companies",
"attributes": {
"name": "Client320",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:03:42.295+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 136
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "454",
"type": "companies",
"attributes": {
"name": "Organization136",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:03:42.258+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 136
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Removes reaction from commentPATCH/api/v2/comments/{id}/remove_reaction
URI Parameters
- id
number
(required) Example: 1comment id
Generated by aglio on 23 Jan 2021
Comments ¶