API Documentation
Todos ¶
Todos ¶
Supported filter params
-
deal_id (array)
-
task_id (array)
-
assignee_id (array)
-
status (1: open, 2: closed)
-
due_date
GET /api/v2/todos
Requests
GET /api/v2/todos
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": "8",
"type": "todos",
"attributes": {
"description": "You need to do this.",
"closed_at": null,
"closed": false,
"due_date": "2024-03-28",
"created_at": "2024-03-28T05:18:18.486+01:00",
"todoable_type": "deal",
"due_time": null,
"position": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2105"
}
},
"assignee": {
"data": {
"type": "people",
"id": "8711"
}
},
"deal": {
"data": {
"type": "deals",
"id": "1753"
}
},
"task": {
"data": null
}
}
}
],
"included": [
{
"id": "8711",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user8626@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": "2024-03-28T05:18:18.000+01:00",
"last_seen_at": "2024-03-28T05:18:18.502+01:00",
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 8690,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:18:18.359+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2105"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9071"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "1753",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2024-03-28",
"end_date": null,
"number": "1",
"deal_number": "1",
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": false,
"sales_status_id": 1,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"email_key": "c1b5ec5679934983a2e40faeb06ecc77",
"purchase_order_number": null,
"custom_fields": null,
"position": 1,
"service_type_restricted_tracking": false,
"tracking_type_id": 1,
"editor_config": {},
"discount": null,
"man_day_minutes": null,
"rounding_interval_id": null,
"rounding_method_id": null,
"billable_time": 0,
"budget_warning": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"probability": 50,
"note_interpolated": null,
"todo_count": 1,
"todo_due_date": "2024-03-28",
"note": null,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": "2024-03-28T05:18:18.000+01:00",
"deleted_at": null,
"created_at": "2024-03-28T05:18:18.452+01:00",
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2024-03-28",
"sales_closed_on": null,
"sample_data": false,
"external_id": null,
"external_sync": false,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"draft_invoiced": 0,
"draft_invoiced_default": 0,
"draft_invoiced_normalized": 0,
"amount_credited": 0,
"amount_credited_default": 0,
"amount_credited_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2105"
}
},
"creator": {
"data": {
"type": "people",
"id": "8711"
}
},
"company": {
"data": {
"type": "companies",
"id": "6657"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "8711"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "11633"
}
},
"project": {
"data": {
"type": "projects",
"id": "2338"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
},
"template": {
"data": null
},
"custom_field_people": {
"data": []
},
"memberships": {
"data": [
{
"type": "memberships",
"id": "7300"
},
{
"type": "memberships",
"id": "7301"
}
]
}
}
},
{
"id": "9071",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2105"
}
}
}
},
{
"id": "6657",
"type": "companies",
"attributes": {
"name": "Client4601",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-28T05:18:18.442+01:00",
"last_activity_at": "2024-03-28T05:18:18.442+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE1",
"domain": null,
"projectless_budgets": false,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2105"
}
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "11633",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"color_id": null,
"archived_at": null,
"time_tracking_enabled": true,
"expense_tracking_enabled": true,
"booking_tracking_enabled": true,
"status_id": 1,
"probability_enabled": true,
"lost_reason_enabled": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2105"
}
},
"pipeline": {
"data": null
}
}
},
{
"id": "2338",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2024-03-28T05:18:18.000+01:00",
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2024-03-28T05:18:18.398+01:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2105"
}
},
"company": {
"data": {
"type": "companies",
"id": "6656"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "8711"
}
},
"last_actor": {
"data": {
"type": "people",
"id": "8711"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2778"
}
},
"custom_field_people": {
"data": []
},
"template_object": {
"data": null
}
}
},
{
"id": "7300",
"type": "memberships",
"attributes": {
"access_type_id": 5,
"dynamic_group_id": 9,
"options": {},
"target_type": "deal",
"type_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2105"
}
},
"person": {
"data": null
},
"team": {
"data": null
},
"dashboard": {
"meta": {
"included": false
}
},
"deal": {
"data": {
"type": "deals",
"id": "1753"
}
},
"filter": {
"meta": {
"included": false
}
},
"page": {
"meta": {
"included": false
}
},
"project": {
"meta": {
"included": false
}
}
}
},
{
"id": "7301",
"type": "memberships",
"attributes": {
"access_type_id": 5,
"dynamic_group_id": 6,
"options": {},
"target_type": "deal",
"type_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2105"
}
},
"person": {
"data": null
},
"team": {
"data": null
},
"dashboard": {
"meta": {
"included": false
}
},
"deal": {
"data": {
"type": "deals",
"id": "1753"
}
},
"filter": {
"meta": {
"included": false
}
},
"page": {
"meta": {
"included": false
}
},
"project": {
"meta": {
"included": false
}
}
}
},
{
"id": "6656",
"type": "companies",
"attributes": {
"name": "Client4600",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-28T05:18:18.391+01:00",
"last_activity_at": "2024-03-28T05:18:18.391+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE",
"domain": null,
"projectless_budgets": false,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2105"
}
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "2778",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2105"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "3445"
}
]
}
}
},
{
"id": "3445",
"type": "workflow_statuses",
"attributes": {
"name": "Closed",
"color_id": 1,
"position": 1,
"category_id": 3
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2105"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2778"
}
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/todos?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/todos?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 1000
},
"private_custom_reports": {
"type": "metered",
"limit": 1000
},
"public_project_reports": {
"type": "metered",
"limit": 1000
},
"private_project_reports": {
"type": "metered",
"limit": 1000
},
"scheduling_placeholders": {
"type": "metered",
"limit": 10
},
"workflows": {
"type": "metered",
"limit": 10
},
"rate_cards": {
"type": "metered",
"limit": 30
},
"teams": {
"type": "metered",
"limit": 20
},
"outgoing_emails": {
"type": "metered",
"limit": 100
},
"recycle_bin": {
"type": "metered",
"limit": 730
},
"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
},
"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
},
"time_calendar_layout": {
"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
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"type": "switch",
"available": true
},
"time_locking": {
"type": "switch",
"available": true
},
"docs": {
"type": "switch",
"available": true
},
"scheduling_resource_utilization": {
"type": "switch",
"available": true
},
"enforce_two_factor_auth": {
"type": "switch",
"available": true
},
"personio_integration": {
"type": "switch",
"available": true
},
"task_dependencies": {
"type": "switch",
"available": true
},
"hris_integration": {
"type": "switch",
"available": true
},
"numbering_scheme": {
"type": "switch",
"available": true
},
"automations": {
"type": "metered",
"limit": 5000
},
"dashboards_sharing": {
"type": "switch",
"available": true
},
"currency_picker": {
"type": "switch",
"available": true
},
"required_custom_fields": {
"type": "switch",
"available": true
},
"restricted_tracking": {
"type": "switch",
"available": true
},
"enforce_sso": {
"type": "switch",
"available": true
},
"jira_integration": {
"type": "switch",
"available": true
},
"docs_versions": {
"type": "switch",
"available": true
},
"zapier_integration": {
"type": "switch",
"available": true
},
"recurring_budgets": {
"type": "switch",
"available": true
},
"restricted_user_roles": {
"type": "switch",
"available": true
},
"service_tracking_toggle": {
"type": "switch",
"available": true
},
"repeating_tasks": {
"type": "switch",
"available": true
},
"save_public_and_private_view": {
"type": "switch",
"available": true
},
"overhead_cost": {
"type": "switch",
"available": true
},
"show_only_filtered_data": {
"type": "switch",
"available": true
},
"invoicing_integrations": {
"type": "switch",
"available": true
},
"audit_log": {
"type": "switch",
"available": true
},
"hubspot_integration": {
"type": "switch",
"available": true
},
"booking_activity_modal": {
"type": "switch",
"available": true
},
"person_custom_field": {
"type": "switch",
"available": true
},
"template_center": {
"type": "switch",
"available": true
},
"custom_roles": {
"type": "switch",
"available": true
},
"purchase_orders": {
"type": "switch",
"available": true
},
"payment_reminders": {
"type": "switch",
"available": true
},
"gantt": {
"type": "switch",
"available": true
},
"tentative_bookings": {
"type": "switch",
"available": true
},
"task_view_sharing": {
"type": "switch",
"available": true
},
"org_chart": {
"type": "switch",
"available": true
},
"person_status": {
"type": "switch",
"available": true
},
"deal_cost_rates": {
"type": "switch",
"available": true
},
"custom_man_days": {
"type": "switch",
"available": true
},
"workload_view": {
"type": "switch",
"available": true
},
"xero_expense_sync": {
"type": "switch",
"available": true
},
"rippling_integration": {
"type": "switch",
"available": true
},
"document_styler": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Get todosGET/api/v2/todos
GET /api/v2/todos/1
Requests
GET /api/v2/todos/9
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": "9",
"type": "todos",
"attributes": {
"description": "You need to do this.",
"closed_at": null,
"closed": false,
"due_date": "2024-03-28",
"created_at": "2024-03-28T05:18:18.754+01:00",
"todoable_type": "deal",
"due_time": null,
"position": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2106"
}
},
"assignee": {
"data": {
"type": "people",
"id": "8712"
}
},
"deal": {
"data": {
"type": "deals",
"id": "1754"
}
},
"task": {
"data": null
}
}
},
"included": [
{
"id": "8712",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user8627@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": "2024-03-28T05:18:18.000+01:00",
"last_seen_at": "2024-03-28T05:18:18.768+01:00",
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 8691,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:18:18.616+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2106"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9072"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "1754",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2024-03-28",
"end_date": null,
"number": "1",
"deal_number": "1",
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": false,
"sales_status_id": 1,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"email_key": "b3ab6a5917f3659f461c48e1ec9dcd7f",
"purchase_order_number": null,
"custom_fields": null,
"position": 1,
"service_type_restricted_tracking": false,
"tracking_type_id": 1,
"editor_config": {},
"discount": null,
"man_day_minutes": null,
"rounding_interval_id": null,
"rounding_method_id": null,
"billable_time": 0,
"budget_warning": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"probability": 50,
"note_interpolated": null,
"todo_count": 1,
"todo_due_date": "2024-03-28",
"note": null,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": "2024-03-28T05:18:18.000+01:00",
"deleted_at": null,
"created_at": "2024-03-28T05:18:18.722+01:00",
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2024-03-28",
"sales_closed_on": null,
"sample_data": false,
"external_id": null,
"external_sync": false,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"draft_invoiced": 0,
"draft_invoiced_default": 0,
"draft_invoiced_normalized": 0,
"amount_credited": 0,
"amount_credited_default": 0,
"amount_credited_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2106"
}
},
"creator": {
"data": {
"type": "people",
"id": "8712"
}
},
"company": {
"data": {
"type": "companies",
"id": "6660"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "8712"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "11639"
}
},
"project": {
"data": {
"type": "projects",
"id": "2339"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
},
"template": {
"data": null
},
"custom_field_people": {
"data": []
},
"memberships": {
"data": [
{
"type": "memberships",
"id": "7303"
},
{
"type": "memberships",
"id": "7304"
}
]
}
}
},
{
"id": "9072",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2106"
}
}
}
},
{
"id": "6660",
"type": "companies",
"attributes": {
"name": "Client4603",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-28T05:18:18.712+01:00",
"last_activity_at": "2024-03-28T05:18:18.712+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE1",
"domain": null,
"projectless_budgets": false,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2106"
}
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "11639",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"color_id": null,
"archived_at": null,
"time_tracking_enabled": true,
"expense_tracking_enabled": true,
"booking_tracking_enabled": true,
"status_id": 1,
"probability_enabled": true,
"lost_reason_enabled": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2106"
}
},
"pipeline": {
"data": null
}
}
},
{
"id": "2339",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2024-03-28T05:18:18.000+01:00",
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2024-03-28T05:18:18.653+01:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2106"
}
},
"company": {
"data": {
"type": "companies",
"id": "6659"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "8712"
}
},
"last_actor": {
"data": {
"type": "people",
"id": "8712"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2780"
}
},
"custom_field_people": {
"data": []
},
"template_object": {
"data": null
}
}
},
{
"id": "7303",
"type": "memberships",
"attributes": {
"access_type_id": 5,
"dynamic_group_id": 9,
"options": {},
"target_type": "deal",
"type_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2106"
}
},
"person": {
"data": null
},
"team": {
"data": null
},
"dashboard": {
"meta": {
"included": false
}
},
"deal": {
"data": {
"type": "deals",
"id": "1754"
}
},
"filter": {
"meta": {
"included": false
}
},
"page": {
"meta": {
"included": false
}
},
"project": {
"meta": {
"included": false
}
}
}
},
{
"id": "7304",
"type": "memberships",
"attributes": {
"access_type_id": 5,
"dynamic_group_id": 6,
"options": {},
"target_type": "deal",
"type_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2106"
}
},
"person": {
"data": null
},
"team": {
"data": null
},
"dashboard": {
"meta": {
"included": false
}
},
"deal": {
"data": {
"type": "deals",
"id": "1754"
}
},
"filter": {
"meta": {
"included": false
}
},
"page": {
"meta": {
"included": false
}
},
"project": {
"meta": {
"included": false
}
}
}
},
{
"id": "6659",
"type": "companies",
"attributes": {
"name": "Client4602",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-28T05:18:18.647+01:00",
"last_activity_at": "2024-03-28T05:18:18.647+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE",
"domain": null,
"projectless_budgets": false,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2106"
}
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "2780",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2106"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "3448"
}
]
}
}
},
{
"id": "3448",
"type": "workflow_statuses",
"attributes": {
"name": "Closed",
"color_id": 1,
"position": 1,
"category_id": 3
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2106"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2780"
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 1000
},
"private_custom_reports": {
"type": "metered",
"limit": 1000
},
"public_project_reports": {
"type": "metered",
"limit": 1000
},
"private_project_reports": {
"type": "metered",
"limit": 1000
},
"scheduling_placeholders": {
"type": "metered",
"limit": 10
},
"workflows": {
"type": "metered",
"limit": 10
},
"rate_cards": {
"type": "metered",
"limit": 30
},
"teams": {
"type": "metered",
"limit": 20
},
"outgoing_emails": {
"type": "metered",
"limit": 100
},
"recycle_bin": {
"type": "metered",
"limit": 730
},
"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
},
"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
},
"time_calendar_layout": {
"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
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"type": "switch",
"available": true
},
"time_locking": {
"type": "switch",
"available": true
},
"docs": {
"type": "switch",
"available": true
},
"scheduling_resource_utilization": {
"type": "switch",
"available": true
},
"enforce_two_factor_auth": {
"type": "switch",
"available": true
},
"personio_integration": {
"type": "switch",
"available": true
},
"task_dependencies": {
"type": "switch",
"available": true
},
"hris_integration": {
"type": "switch",
"available": true
},
"numbering_scheme": {
"type": "switch",
"available": true
},
"automations": {
"type": "metered",
"limit": 5000
},
"dashboards_sharing": {
"type": "switch",
"available": true
},
"currency_picker": {
"type": "switch",
"available": true
},
"required_custom_fields": {
"type": "switch",
"available": true
},
"restricted_tracking": {
"type": "switch",
"available": true
},
"enforce_sso": {
"type": "switch",
"available": true
},
"jira_integration": {
"type": "switch",
"available": true
},
"docs_versions": {
"type": "switch",
"available": true
},
"zapier_integration": {
"type": "switch",
"available": true
},
"recurring_budgets": {
"type": "switch",
"available": true
},
"restricted_user_roles": {
"type": "switch",
"available": true
},
"service_tracking_toggle": {
"type": "switch",
"available": true
},
"repeating_tasks": {
"type": "switch",
"available": true
},
"save_public_and_private_view": {
"type": "switch",
"available": true
},
"overhead_cost": {
"type": "switch",
"available": true
},
"show_only_filtered_data": {
"type": "switch",
"available": true
},
"invoicing_integrations": {
"type": "switch",
"available": true
},
"audit_log": {
"type": "switch",
"available": true
},
"hubspot_integration": {
"type": "switch",
"available": true
},
"booking_activity_modal": {
"type": "switch",
"available": true
},
"person_custom_field": {
"type": "switch",
"available": true
},
"template_center": {
"type": "switch",
"available": true
},
"custom_roles": {
"type": "switch",
"available": true
},
"purchase_orders": {
"type": "switch",
"available": true
},
"payment_reminders": {
"type": "switch",
"available": true
},
"gantt": {
"type": "switch",
"available": true
},
"tentative_bookings": {
"type": "switch",
"available": true
},
"task_view_sharing": {
"type": "switch",
"available": true
},
"org_chart": {
"type": "switch",
"available": true
},
"person_status": {
"type": "switch",
"available": true
},
"deal_cost_rates": {
"type": "switch",
"available": true
},
"custom_man_days": {
"type": "switch",
"available": true
},
"workload_view": {
"type": "switch",
"available": true
},
"xero_expense_sync": {
"type": "switch",
"available": true
},
"rippling_integration": {
"type": "switch",
"available": true
},
"document_styler": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/todos
Requests
POST /api/v2/todos
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": "todos",
"attributes": {
"description": "Test description"
},
"relationships": {
"task": {
"data": {
"type": "tasks",
"id": "12598"
}
},
"assignee": {
"data": {
"type": "assignees",
"id": "8713"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "11",
"type": "todos",
"attributes": {
"description": "Test description",
"closed_at": null,
"closed": false,
"due_date": null,
"created_at": "2024-03-28T05:18:19.034+01:00",
"todoable_type": "task",
"due_time": null,
"position": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2107"
}
},
"assignee": {
"data": {
"type": "people",
"id": "8713"
}
},
"deal": {
"data": null
},
"task": {
"data": {
"type": "tasks",
"id": "12598"
}
}
}
},
"included": [
{
"id": "8713",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user8628@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": "2024-03-28T05:18:19.000+01:00",
"last_seen_at": "2024-03-28T05:18:19.021+01:00",
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 8692,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:18:18.879+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2107"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9073"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "12598",
"type": "tasks",
"attributes": {
"title": "Ticket title",
"description": null,
"number": "1",
"task_number": "1",
"private": false,
"due_date": null,
"start_date": null,
"closed_at": null,
"created_at": "2024-03-28T05:18:18.954+01:00",
"updated_at": "2024-03-28T05:18:19.043+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": "d7854363c92d2853b12a8d7244633ae1",
"custom_fields": null,
"todo_count": 1,
"open_todo_count": 1,
"subtask_count": null,
"open_subtask_count": null,
"creation_method_id": 1,
"todo_assignee_ids": [
"8713"
],
"task_dependency_count": 0,
"type_id": 1,
"blocking_dependency_count": 0,
"waiting_on_dependency_count": 0,
"linked_dependency_count": 0,
"placement": null,
"subtask_placement": null,
"closed": false,
"due_time": null,
"tag_list": [],
"last_activity_at": "2024-03-28T05:18:18.000+01:00",
"initial_estimate": null,
"remaining_time": null,
"billable_time": null,
"worked_time": null,
"deleted_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2107"
}
},
"project": {
"data": {
"type": "projects",
"id": "2340"
}
},
"creator": {
"data": {
"type": "people",
"id": "8713"
}
},
"assignee": {
"data": null
},
"last_actor": {
"data": {
"type": "people",
"id": "8713"
}
},
"task_list": {
"data": {
"type": "task_lists",
"id": "588"
}
},
"parent_task": {
"data": null
},
"workflow_status": {
"data": {
"type": "workflow_statuses",
"id": "3453"
}
},
"repeated_task": {
"data": null
},
"attachments": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "9073",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2107"
}
}
}
},
{
"id": "2340",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2024-03-28T05:18:18.000+01:00",
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2024-03-28T05:18:18.919+01:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2107"
}
},
"company": {
"data": {
"type": "companies",
"id": "6662"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "8713"
}
},
"last_actor": {
"data": {
"type": "people",
"id": "8713"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2782"
}
},
"custom_field_people": {
"data": []
},
"template_object": {
"data": null
}
}
},
{
"id": "588",
"type": "task_lists",
"attributes": {
"name": "Milestone556",
"position": 1,
"placement": null,
"archived_at": null,
"email_key": "8aea13c657cf8425d4499e196259ad0c"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2107"
}
},
"project": {
"data": {
"type": "projects",
"id": "2340"
}
},
"board": {
"data": {
"type": "boards",
"id": "606"
}
}
}
},
{
"id": "3453",
"type": "workflow_statuses",
"attributes": {
"name": "Open",
"color_id": 1,
"position": 1,
"category_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2107"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2783"
}
}
}
},
{
"id": "6662",
"type": "companies",
"attributes": {
"name": "Client4604",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-28T05:18:18.912+01:00",
"last_activity_at": "2024-03-28T05:18:18.912+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE",
"domain": null,
"projectless_budgets": false,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2107"
}
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "2782",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2107"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "3451"
}
]
}
}
},
{
"id": "606",
"type": "boards",
"attributes": {
"name": "Board575",
"position": 1,
"placement": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2107"
}
},
"project": {
"data": {
"type": "projects",
"id": "2340"
}
}
}
},
{
"id": "2783",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2107"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "3452"
},
{
"type": "workflow_statuses",
"id": "3453"
}
]
}
}
},
{
"id": "3451",
"type": "workflow_statuses",
"attributes": {
"name": "Closed",
"color_id": 1,
"position": 1,
"category_id": 3
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2107"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2782"
}
}
}
},
{
"id": "3452",
"type": "workflow_statuses",
"attributes": {
"name": "Closed",
"color_id": 1,
"position": 1,
"category_id": 3
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2107"
}
},
"workflow": {
"meta": {
"included": false
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 1000
},
"private_custom_reports": {
"type": "metered",
"limit": 1000
},
"public_project_reports": {
"type": "metered",
"limit": 1000
},
"private_project_reports": {
"type": "metered",
"limit": 1000
},
"scheduling_placeholders": {
"type": "metered",
"limit": 10
},
"workflows": {
"type": "metered",
"limit": 10
},
"rate_cards": {
"type": "metered",
"limit": 30
},
"teams": {
"type": "metered",
"limit": 20
},
"outgoing_emails": {
"type": "metered",
"limit": 100
},
"recycle_bin": {
"type": "metered",
"limit": 730
},
"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
},
"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
},
"time_calendar_layout": {
"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
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"type": "switch",
"available": true
},
"time_locking": {
"type": "switch",
"available": true
},
"docs": {
"type": "switch",
"available": true
},
"scheduling_resource_utilization": {
"type": "switch",
"available": true
},
"enforce_two_factor_auth": {
"type": "switch",
"available": true
},
"personio_integration": {
"type": "switch",
"available": true
},
"task_dependencies": {
"type": "switch",
"available": true
},
"hris_integration": {
"type": "switch",
"available": true
},
"numbering_scheme": {
"type": "switch",
"available": true
},
"automations": {
"type": "metered",
"limit": 5000
},
"dashboards_sharing": {
"type": "switch",
"available": true
},
"currency_picker": {
"type": "switch",
"available": true
},
"required_custom_fields": {
"type": "switch",
"available": true
},
"restricted_tracking": {
"type": "switch",
"available": true
},
"enforce_sso": {
"type": "switch",
"available": true
},
"jira_integration": {
"type": "switch",
"available": true
},
"docs_versions": {
"type": "switch",
"available": true
},
"zapier_integration": {
"type": "switch",
"available": true
},
"recurring_budgets": {
"type": "switch",
"available": true
},
"restricted_user_roles": {
"type": "switch",
"available": true
},
"service_tracking_toggle": {
"type": "switch",
"available": true
},
"repeating_tasks": {
"type": "switch",
"available": true
},
"save_public_and_private_view": {
"type": "switch",
"available": true
},
"overhead_cost": {
"type": "switch",
"available": true
},
"show_only_filtered_data": {
"type": "switch",
"available": true
},
"invoicing_integrations": {
"type": "switch",
"available": true
},
"audit_log": {
"type": "switch",
"available": true
},
"hubspot_integration": {
"type": "switch",
"available": true
},
"booking_activity_modal": {
"type": "switch",
"available": true
},
"person_custom_field": {
"type": "switch",
"available": true
},
"template_center": {
"type": "switch",
"available": true
},
"custom_roles": {
"type": "switch",
"available": true
},
"purchase_orders": {
"type": "switch",
"available": true
},
"payment_reminders": {
"type": "switch",
"available": true
},
"gantt": {
"type": "switch",
"available": true
},
"tentative_bookings": {
"type": "switch",
"available": true
},
"task_view_sharing": {
"type": "switch",
"available": true
},
"org_chart": {
"type": "switch",
"available": true
},
"person_status": {
"type": "switch",
"available": true
},
"deal_cost_rates": {
"type": "switch",
"available": true
},
"custom_man_days": {
"type": "switch",
"available": true
},
"workload_view": {
"type": "switch",
"available": true
},
"xero_expense_sync": {
"type": "switch",
"available": true
},
"rippling_integration": {
"type": "switch",
"available": true
},
"document_styler": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/todos
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": "todos",
"attributes": {
"description": "Test description"
},
"relationships": {
"deal": {
"data": {
"type": "deals",
"id": "1756"
}
},
"assignee": {
"data": {
"type": "assignees",
"id": "8714"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "13",
"type": "todos",
"attributes": {
"description": "Test description",
"closed_at": null,
"closed": false,
"due_date": null,
"created_at": "2024-03-28T05:18:19.318+01:00",
"todoable_type": "deal",
"due_time": null,
"position": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2108"
}
},
"assignee": {
"data": {
"type": "people",
"id": "8714"
}
},
"deal": {
"data": {
"type": "deals",
"id": "1756"
}
},
"task": {
"data": null
}
}
},
"included": [
{
"id": "8714",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user8629@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": "2024-03-28T05:18:19.000+01:00",
"last_seen_at": "2024-03-28T05:18:19.309+01:00",
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 8693,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:18:19.160+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2108"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9074"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "1756",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2024-03-28",
"end_date": null,
"number": "1",
"deal_number": "1",
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": false,
"sales_status_id": 1,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"email_key": "7d7fd891177bb7a58e008311df3ec53b",
"purchase_order_number": null,
"custom_fields": null,
"position": 1,
"service_type_restricted_tracking": false,
"tracking_type_id": 1,
"editor_config": {},
"discount": null,
"man_day_minutes": null,
"rounding_interval_id": null,
"rounding_method_id": null,
"billable_time": 0,
"budget_warning": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"probability": 50,
"note_interpolated": null,
"todo_count": 2,
"todo_due_date": "2024-03-28",
"note": null,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": "2024-03-28T05:18:19.000+01:00",
"deleted_at": null,
"created_at": "2024-03-28T05:18:19.259+01:00",
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2024-03-28",
"sales_closed_on": null,
"sample_data": false,
"external_id": null,
"external_sync": false,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"draft_invoiced": 0,
"draft_invoiced_default": 0,
"draft_invoiced_normalized": 0,
"amount_credited": 0,
"amount_credited_default": 0,
"amount_credited_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2108"
}
},
"creator": {
"data": {
"type": "people",
"id": "8714"
}
},
"company": {
"data": {
"type": "companies",
"id": "6666"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "8714"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "11651"
}
},
"project": {
"data": {
"type": "projects",
"id": "2341"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
},
"template": {
"data": null
},
"custom_field_people": {
"data": []
},
"memberships": {
"data": [
{
"type": "memberships",
"id": "7309"
},
{
"type": "memberships",
"id": "7310"
}
]
}
}
},
{
"id": "9074",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2108"
}
}
}
},
{
"id": "6666",
"type": "companies",
"attributes": {
"name": "Client4607",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-28T05:18:19.245+01:00",
"last_activity_at": "2024-03-28T05:18:19.245+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE1",
"domain": null,
"projectless_budgets": false,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2108"
}
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "11651",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"color_id": null,
"archived_at": null,
"time_tracking_enabled": true,
"expense_tracking_enabled": true,
"booking_tracking_enabled": true,
"status_id": 1,
"probability_enabled": true,
"lost_reason_enabled": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2108"
}
},
"pipeline": {
"data": null
}
}
},
{
"id": "2341",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2024-03-28T05:18:19.000+01:00",
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2024-03-28T05:18:19.203+01:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2108"
}
},
"company": {
"data": {
"type": "companies",
"id": "6665"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "8714"
}
},
"last_actor": {
"data": {
"type": "people",
"id": "8714"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2784"
}
},
"custom_field_people": {
"data": []
},
"template_object": {
"data": null
}
}
},
{
"id": "7309",
"type": "memberships",
"attributes": {
"access_type_id": 5,
"dynamic_group_id": 9,
"options": {},
"target_type": "deal",
"type_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2108"
}
},
"person": {
"data": null
},
"team": {
"data": null
},
"dashboard": {
"meta": {
"included": false
}
},
"deal": {
"data": {
"type": "deals",
"id": "1756"
}
},
"filter": {
"meta": {
"included": false
}
},
"page": {
"meta": {
"included": false
}
},
"project": {
"meta": {
"included": false
}
}
}
},
{
"id": "7310",
"type": "memberships",
"attributes": {
"access_type_id": 5,
"dynamic_group_id": 6,
"options": {},
"target_type": "deal",
"type_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2108"
}
},
"person": {
"data": null
},
"team": {
"data": null
},
"dashboard": {
"meta": {
"included": false
}
},
"deal": {
"data": {
"type": "deals",
"id": "1756"
}
},
"filter": {
"meta": {
"included": false
}
},
"page": {
"meta": {
"included": false
}
},
"project": {
"meta": {
"included": false
}
}
}
},
{
"id": "6665",
"type": "companies",
"attributes": {
"name": "Client4606",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-28T05:18:19.196+01:00",
"last_activity_at": "2024-03-28T05:18:19.197+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE",
"domain": null,
"projectless_budgets": false,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2108"
}
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "2784",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2108"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "3454"
}
]
}
}
},
{
"id": "3454",
"type": "workflow_statuses",
"attributes": {
"name": "Closed",
"color_id": 1,
"position": 1,
"category_id": 3
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2108"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2784"
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 1000
},
"private_custom_reports": {
"type": "metered",
"limit": 1000
},
"public_project_reports": {
"type": "metered",
"limit": 1000
},
"private_project_reports": {
"type": "metered",
"limit": 1000
},
"scheduling_placeholders": {
"type": "metered",
"limit": 10
},
"workflows": {
"type": "metered",
"limit": 10
},
"rate_cards": {
"type": "metered",
"limit": 30
},
"teams": {
"type": "metered",
"limit": 20
},
"outgoing_emails": {
"type": "metered",
"limit": 100
},
"recycle_bin": {
"type": "metered",
"limit": 730
},
"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
},
"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
},
"time_calendar_layout": {
"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
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"type": "switch",
"available": true
},
"time_locking": {
"type": "switch",
"available": true
},
"docs": {
"type": "switch",
"available": true
},
"scheduling_resource_utilization": {
"type": "switch",
"available": true
},
"enforce_two_factor_auth": {
"type": "switch",
"available": true
},
"personio_integration": {
"type": "switch",
"available": true
},
"task_dependencies": {
"type": "switch",
"available": true
},
"hris_integration": {
"type": "switch",
"available": true
},
"numbering_scheme": {
"type": "switch",
"available": true
},
"automations": {
"type": "metered",
"limit": 5000
},
"dashboards_sharing": {
"type": "switch",
"available": true
},
"currency_picker": {
"type": "switch",
"available": true
},
"required_custom_fields": {
"type": "switch",
"available": true
},
"restricted_tracking": {
"type": "switch",
"available": true
},
"enforce_sso": {
"type": "switch",
"available": true
},
"jira_integration": {
"type": "switch",
"available": true
},
"docs_versions": {
"type": "switch",
"available": true
},
"zapier_integration": {
"type": "switch",
"available": true
},
"recurring_budgets": {
"type": "switch",
"available": true
},
"restricted_user_roles": {
"type": "switch",
"available": true
},
"service_tracking_toggle": {
"type": "switch",
"available": true
},
"repeating_tasks": {
"type": "switch",
"available": true
},
"save_public_and_private_view": {
"type": "switch",
"available": true
},
"overhead_cost": {
"type": "switch",
"available": true
},
"show_only_filtered_data": {
"type": "switch",
"available": true
},
"invoicing_integrations": {
"type": "switch",
"available": true
},
"audit_log": {
"type": "switch",
"available": true
},
"hubspot_integration": {
"type": "switch",
"available": true
},
"booking_activity_modal": {
"type": "switch",
"available": true
},
"person_custom_field": {
"type": "switch",
"available": true
},
"template_center": {
"type": "switch",
"available": true
},
"custom_roles": {
"type": "switch",
"available": true
},
"purchase_orders": {
"type": "switch",
"available": true
},
"payment_reminders": {
"type": "switch",
"available": true
},
"gantt": {
"type": "switch",
"available": true
},
"tentative_bookings": {
"type": "switch",
"available": true
},
"task_view_sharing": {
"type": "switch",
"available": true
},
"org_chart": {
"type": "switch",
"available": true
},
"person_status": {
"type": "switch",
"available": true
},
"deal_cost_rates": {
"type": "switch",
"available": true
},
"custom_man_days": {
"type": "switch",
"available": true
},
"workload_view": {
"type": "switch",
"available": true
},
"xero_expense_sync": {
"type": "switch",
"available": true
},
"rippling_integration": {
"type": "switch",
"available": true
},
"document_styler": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/todos
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": "todos",
"attributes": {
"description": "Test description"
},
"relationships": {
"deal": {
"data": {
"type": "deals",
"id": "0"
}
}
}
}
}
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": {}
}
]
}
POST /api/v2/todos
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": "todos",
"attributes": {
"description": "Test description"
},
"relationships": {
"ticket": {
"data": {
"type": "tickets",
"id": "0"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/deal"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/task"
}
}
]
}
POST /api/v2/todos
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": "todos",
"attributes": {
"description": ""
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/deal"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/task"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/description"
}
}
]
}
Create a todoPOST/api/v2/todos
URI Parameters
- deal_id
number
(optional) Example: 1deal id
- task_id
number
(optional) Example: 1task id
- assignee_id
number
(required) Example: 1assignee id
- description
string
(required) Example: Descriptiondescription
PATCH /api/v2/todos/1
Requests
PATCH /api/v2/todos/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+json
Body
{
"data": {
"type": "todo",
"attributes": {
"description": "Update description",
"closed": true
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "17",
"type": "todos",
"attributes": {
"description": "Update description",
"closed_at": "2024-03-28T05:18:20.000+01:00",
"closed": true,
"due_date": "2024-03-28",
"created_at": "2024-03-28T05:18:20.106+01:00",
"todoable_type": "task",
"due_time": null,
"position": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2112"
}
},
"assignee": {
"data": {
"type": "people",
"id": "8718"
}
},
"deal": {
"data": null
},
"task": {
"data": {
"type": "tasks",
"id": "12603"
}
}
}
},
"included": [
{
"id": "8718",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user8633@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": "2024-03-28T05:18:20.000+01:00",
"last_seen_at": "2024-03-28T05:18:20.126+01:00",
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 8697,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:18:19.957+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2112"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9078"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "12603",
"type": "tasks",
"attributes": {
"title": "Ticket title",
"description": null,
"number": "1",
"task_number": "1",
"private": false,
"due_date": null,
"start_date": null,
"closed_at": null,
"created_at": "2024-03-28T05:18:20.051+01:00",
"updated_at": "2024-03-28T05:18:20.139+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": "1e85937d480aceca8c421562be5e197c",
"custom_fields": null,
"todo_count": 1,
"open_todo_count": 0,
"subtask_count": null,
"open_subtask_count": null,
"creation_method_id": 1,
"todo_assignee_ids": [],
"task_dependency_count": 0,
"type_id": 1,
"blocking_dependency_count": 0,
"waiting_on_dependency_count": 0,
"linked_dependency_count": 0,
"placement": null,
"subtask_placement": null,
"closed": false,
"due_time": null,
"tag_list": [],
"last_activity_at": "2024-03-28T05:18:20.000+01:00",
"initial_estimate": null,
"remaining_time": null,
"billable_time": null,
"worked_time": null,
"deleted_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2112"
}
},
"project": {
"data": {
"type": "projects",
"id": "2345"
}
},
"creator": {
"data": {
"type": "people",
"id": "8718"
}
},
"assignee": {
"data": null
},
"last_actor": {
"data": {
"type": "people",
"id": "8718"
}
},
"task_list": {
"data": {
"type": "task_lists",
"id": "593"
}
},
"parent_task": {
"data": null
},
"workflow_status": {
"data": {
"type": "workflow_statuses",
"id": "3468"
}
},
"repeated_task": {
"data": null
},
"attachments": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "9078",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2112"
}
}
}
},
{
"id": "2345",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2024-03-28T05:18:19.000+01:00",
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2024-03-28T05:18:19.992+01:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2112"
}
},
"company": {
"data": {
"type": "companies",
"id": "6677"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "8718"
}
},
"last_actor": {
"data": {
"type": "people",
"id": "8718"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2792"
}
},
"custom_field_people": {
"data": []
},
"template_object": {
"data": null
}
}
},
{
"id": "593",
"type": "task_lists",
"attributes": {
"name": "Milestone561",
"position": 1,
"placement": null,
"archived_at": null,
"email_key": "7e21b6a82a148b22b25fc7fd60b5d168"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2112"
}
},
"project": {
"data": {
"type": "projects",
"id": "2345"
}
},
"board": {
"data": {
"type": "boards",
"id": "611"
}
}
}
},
{
"id": "3468",
"type": "workflow_statuses",
"attributes": {
"name": "Open",
"color_id": 1,
"position": 1,
"category_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2112"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2793"
}
}
}
},
{
"id": "6677",
"type": "companies",
"attributes": {
"name": "Client4614",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-28T05:18:19.986+01:00",
"last_activity_at": "2024-03-28T05:18:19.986+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE",
"domain": null,
"projectless_budgets": false,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2112"
}
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "2792",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2112"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "3466"
}
]
}
}
},
{
"id": "611",
"type": "boards",
"attributes": {
"name": "Board580",
"position": 1,
"placement": null,
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2112"
}
},
"project": {
"data": {
"type": "projects",
"id": "2345"
}
}
}
},
{
"id": "2793",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2112"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "3467"
},
{
"type": "workflow_statuses",
"id": "3468"
}
]
}
}
},
{
"id": "3466",
"type": "workflow_statuses",
"attributes": {
"name": "Closed",
"color_id": 1,
"position": 1,
"category_id": 3
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2112"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2792"
}
}
}
},
{
"id": "3467",
"type": "workflow_statuses",
"attributes": {
"name": "Closed",
"color_id": 1,
"position": 1,
"category_id": 3
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2112"
}
},
"workflow": {
"meta": {
"included": false
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 1000
},
"private_custom_reports": {
"type": "metered",
"limit": 1000
},
"public_project_reports": {
"type": "metered",
"limit": 1000
},
"private_project_reports": {
"type": "metered",
"limit": 1000
},
"scheduling_placeholders": {
"type": "metered",
"limit": 10
},
"workflows": {
"type": "metered",
"limit": 10
},
"rate_cards": {
"type": "metered",
"limit": 30
},
"teams": {
"type": "metered",
"limit": 20
},
"outgoing_emails": {
"type": "metered",
"limit": 100
},
"recycle_bin": {
"type": "metered",
"limit": 730
},
"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
},
"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
},
"time_calendar_layout": {
"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
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"type": "switch",
"available": true
},
"time_locking": {
"type": "switch",
"available": true
},
"docs": {
"type": "switch",
"available": true
},
"scheduling_resource_utilization": {
"type": "switch",
"available": true
},
"enforce_two_factor_auth": {
"type": "switch",
"available": true
},
"personio_integration": {
"type": "switch",
"available": true
},
"task_dependencies": {
"type": "switch",
"available": true
},
"hris_integration": {
"type": "switch",
"available": true
},
"numbering_scheme": {
"type": "switch",
"available": true
},
"automations": {
"type": "metered",
"limit": 5000
},
"dashboards_sharing": {
"type": "switch",
"available": true
},
"currency_picker": {
"type": "switch",
"available": true
},
"required_custom_fields": {
"type": "switch",
"available": true
},
"restricted_tracking": {
"type": "switch",
"available": true
},
"enforce_sso": {
"type": "switch",
"available": true
},
"jira_integration": {
"type": "switch",
"available": true
},
"docs_versions": {
"type": "switch",
"available": true
},
"zapier_integration": {
"type": "switch",
"available": true
},
"recurring_budgets": {
"type": "switch",
"available": true
},
"restricted_user_roles": {
"type": "switch",
"available": true
},
"service_tracking_toggle": {
"type": "switch",
"available": true
},
"repeating_tasks": {
"type": "switch",
"available": true
},
"save_public_and_private_view": {
"type": "switch",
"available": true
},
"overhead_cost": {
"type": "switch",
"available": true
},
"show_only_filtered_data": {
"type": "switch",
"available": true
},
"invoicing_integrations": {
"type": "switch",
"available": true
},
"audit_log": {
"type": "switch",
"available": true
},
"hubspot_integration": {
"type": "switch",
"available": true
},
"booking_activity_modal": {
"type": "switch",
"available": true
},
"person_custom_field": {
"type": "switch",
"available": true
},
"template_center": {
"type": "switch",
"available": true
},
"custom_roles": {
"type": "switch",
"available": true
},
"purchase_orders": {
"type": "switch",
"available": true
},
"payment_reminders": {
"type": "switch",
"available": true
},
"gantt": {
"type": "switch",
"available": true
},
"tentative_bookings": {
"type": "switch",
"available": true
},
"task_view_sharing": {
"type": "switch",
"available": true
},
"org_chart": {
"type": "switch",
"available": true
},
"person_status": {
"type": "switch",
"available": true
},
"deal_cost_rates": {
"type": "switch",
"available": true
},
"custom_man_days": {
"type": "switch",
"available": true
},
"workload_view": {
"type": "switch",
"available": true
},
"xero_expense_sync": {
"type": "switch",
"available": true
},
"rippling_integration": {
"type": "switch",
"available": true
},
"document_styler": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCH /api/v2/todos/18
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": "todo",
"attributes": {
"description": "Update description",
"closed": true
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "18",
"type": "todos",
"attributes": {
"description": "Update description",
"closed_at": "2024-03-28T05:18:20.000+01:00",
"closed": true,
"due_date": "2024-03-28",
"created_at": "2024-03-28T05:18:20.375+01:00",
"todoable_type": "deal",
"due_time": null,
"position": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2113"
}
},
"assignee": {
"data": {
"type": "people",
"id": "8719"
}
},
"deal": {
"data": {
"type": "deals",
"id": "1761"
}
},
"task": {
"data": null
}
}
},
"included": [
{
"id": "8719",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user8634@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": "2024-03-28T05:18:20.000+01:00",
"last_seen_at": "2024-03-28T05:18:20.389+01:00",
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 8698,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:18:20.261+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2113"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "9079"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "1761",
"type": "deals",
"attributes": {
"name": "test name",
"date": "2024-03-28",
"end_date": null,
"number": "1",
"deal_number": "1",
"suffix": null,
"time_approval": true,
"expense_approval": true,
"client_access": false,
"deal_type_id": 2,
"budget": false,
"sales_status_id": 1,
"sales_status_updated_at": null,
"tag_list": [],
"origin_deal_id": null,
"profit_margin": 0,
"email_key": "5c91b7399a83c98a4670401bd68b6e14",
"purchase_order_number": null,
"custom_fields": null,
"position": 1,
"service_type_restricted_tracking": false,
"tracking_type_id": 1,
"editor_config": {},
"discount": null,
"man_day_minutes": null,
"rounding_interval_id": null,
"rounding_method_id": null,
"billable_time": 0,
"budget_warning": null,
"unapproved_entries_count": 0,
"rejected_entries_count": 0,
"estimated_time": 0,
"budgeted_time": 0,
"worked_time": 0,
"time_to_close": null,
"probability": 50,
"note_interpolated": null,
"todo_count": 0,
"todo_due_date": null,
"note": null,
"lost_comment": null,
"closed_at": null,
"delivered_on": null,
"last_activity_at": "2024-03-28T05:18:20.000+01:00",
"deleted_at": null,
"created_at": "2024-03-28T05:18:20.344+01:00",
"sales_closed_at": null,
"exchange_rate": "1.25",
"exchange_date": "2024-03-28",
"sales_closed_on": null,
"sample_data": false,
"external_id": null,
"external_sync": false,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"services_revenue": 0,
"services_revenue_default": 0,
"services_revenue_normalized": 0,
"budget_total": 0,
"budget_total_default": 0,
"budget_total_normalized": 0,
"budget_used": 0,
"budget_used_default": 0,
"budget_used_normalized": 0,
"projected_revenue": 0,
"projected_revenue_default": 0,
"projected_revenue_normalized": 0,
"cost": 0,
"cost_default": 0,
"cost_normalized": 0,
"profit": 0,
"profit_default": 0,
"profit_normalized": 0,
"invoiced": 0,
"invoiced_default": 0,
"invoiced_normalized": 0,
"pending_invoicing": 0,
"pending_invoicing_default": 0,
"pending_invoicing_normalized": 0,
"draft_invoiced": 0,
"draft_invoiced_default": 0,
"draft_invoiced_normalized": 0,
"amount_credited": 0,
"amount_credited_default": 0,
"amount_credited_normalized": 0,
"expense": 0,
"expense_default": 0,
"expense_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2113"
}
},
"creator": {
"data": {
"type": "people",
"id": "8719"
}
},
"company": {
"data": {
"type": "companies",
"id": "6681"
}
},
"document_type": {
"data": null
},
"responsible": {
"data": {
"type": "people",
"id": "8719"
}
},
"deal_status": {
"data": {
"type": "deal_statuses",
"id": "11681"
}
},
"project": {
"data": {
"type": "projects",
"id": "2346"
}
},
"lost_reason": {
"data": null
},
"contract": {
"data": null
},
"contact": {
"data": null
},
"subsidiary": {
"data": null
},
"template": {
"data": null
},
"custom_field_people": {
"data": []
},
"memberships": {
"data": [
{
"type": "memberships",
"id": "7324"
},
{
"type": "memberships",
"id": "7325"
}
]
}
}
},
{
"id": "9079",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2113"
}
}
}
},
{
"id": "6681",
"type": "companies",
"attributes": {
"name": "Client4617",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-28T05:18:20.335+01:00",
"last_activity_at": "2024-03-28T05:18:20.335+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE1",
"domain": null,
"projectless_budgets": false,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2113"
}
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "11681",
"type": "deal_statuses",
"attributes": {
"name": "prospective",
"position": 6,
"color_id": null,
"archived_at": null,
"time_tracking_enabled": true,
"expense_tracking_enabled": true,
"booking_tracking_enabled": true,
"status_id": 1,
"probability_enabled": true,
"lost_reason_enabled": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2113"
}
},
"pipeline": {
"data": null
}
}
},
{
"id": "2346",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2024-03-28T05:18:20.000+01:00",
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2024-03-28T05:18:20.297+01:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2113"
}
},
"company": {
"data": {
"type": "companies",
"id": "6680"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "8719"
}
},
"last_actor": {
"data": {
"type": "people",
"id": "8719"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2794"
}
},
"custom_field_people": {
"data": []
},
"template_object": {
"data": null
}
}
},
{
"id": "7324",
"type": "memberships",
"attributes": {
"access_type_id": 5,
"dynamic_group_id": 9,
"options": {},
"target_type": "deal",
"type_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2113"
}
},
"person": {
"data": null
},
"team": {
"data": null
},
"dashboard": {
"meta": {
"included": false
}
},
"deal": {
"data": {
"type": "deals",
"id": "1761"
}
},
"filter": {
"meta": {
"included": false
}
},
"page": {
"meta": {
"included": false
}
},
"project": {
"meta": {
"included": false
}
}
}
},
{
"id": "7325",
"type": "memberships",
"attributes": {
"access_type_id": 5,
"dynamic_group_id": 6,
"options": {},
"target_type": "deal",
"type_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2113"
}
},
"person": {
"data": null
},
"team": {
"data": null
},
"dashboard": {
"meta": {
"included": false
}
},
"deal": {
"data": {
"type": "deals",
"id": "1761"
}
},
"filter": {
"meta": {
"included": false
}
},
"page": {
"meta": {
"included": false
}
},
"project": {
"meta": {
"included": false
}
}
}
},
{
"id": "6680",
"type": "companies",
"attributes": {
"name": "Client4616",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-28T05:18:20.290+01:00",
"last_activity_at": "2024-03-28T05:18:20.290+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE",
"domain": null,
"projectless_budgets": false,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2113"
}
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "2794",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2113"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "3469"
}
]
}
}
},
{
"id": "3469",
"type": "workflow_statuses",
"attributes": {
"name": "Closed",
"color_id": 1,
"position": 1,
"category_id": 3
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2113"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2794"
}
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 1000
},
"private_custom_reports": {
"type": "metered",
"limit": 1000
},
"public_project_reports": {
"type": "metered",
"limit": 1000
},
"private_project_reports": {
"type": "metered",
"limit": 1000
},
"scheduling_placeholders": {
"type": "metered",
"limit": 10
},
"workflows": {
"type": "metered",
"limit": 10
},
"rate_cards": {
"type": "metered",
"limit": 30
},
"teams": {
"type": "metered",
"limit": 20
},
"outgoing_emails": {
"type": "metered",
"limit": 100
},
"recycle_bin": {
"type": "metered",
"limit": 730
},
"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
},
"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
},
"time_calendar_layout": {
"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
},
"comment_visibility": {
"type": "switch",
"available": true
},
"time_off_sync": {
"type": "switch",
"available": true
},
"time_locking": {
"type": "switch",
"available": true
},
"docs": {
"type": "switch",
"available": true
},
"scheduling_resource_utilization": {
"type": "switch",
"available": true
},
"enforce_two_factor_auth": {
"type": "switch",
"available": true
},
"personio_integration": {
"type": "switch",
"available": true
},
"task_dependencies": {
"type": "switch",
"available": true
},
"hris_integration": {
"type": "switch",
"available": true
},
"numbering_scheme": {
"type": "switch",
"available": true
},
"automations": {
"type": "metered",
"limit": 5000
},
"dashboards_sharing": {
"type": "switch",
"available": true
},
"currency_picker": {
"type": "switch",
"available": true
},
"required_custom_fields": {
"type": "switch",
"available": true
},
"restricted_tracking": {
"type": "switch",
"available": true
},
"enforce_sso": {
"type": "switch",
"available": true
},
"jira_integration": {
"type": "switch",
"available": true
},
"docs_versions": {
"type": "switch",
"available": true
},
"zapier_integration": {
"type": "switch",
"available": true
},
"recurring_budgets": {
"type": "switch",
"available": true
},
"restricted_user_roles": {
"type": "switch",
"available": true
},
"service_tracking_toggle": {
"type": "switch",
"available": true
},
"repeating_tasks": {
"type": "switch",
"available": true
},
"save_public_and_private_view": {
"type": "switch",
"available": true
},
"overhead_cost": {
"type": "switch",
"available": true
},
"show_only_filtered_data": {
"type": "switch",
"available": true
},
"invoicing_integrations": {
"type": "switch",
"available": true
},
"audit_log": {
"type": "switch",
"available": true
},
"hubspot_integration": {
"type": "switch",
"available": true
},
"booking_activity_modal": {
"type": "switch",
"available": true
},
"person_custom_field": {
"type": "switch",
"available": true
},
"template_center": {
"type": "switch",
"available": true
},
"custom_roles": {
"type": "switch",
"available": true
},
"purchase_orders": {
"type": "switch",
"available": true
},
"payment_reminders": {
"type": "switch",
"available": true
},
"gantt": {
"type": "switch",
"available": true
},
"tentative_bookings": {
"type": "switch",
"available": true
},
"task_view_sharing": {
"type": "switch",
"available": true
},
"org_chart": {
"type": "switch",
"available": true
},
"person_status": {
"type": "switch",
"available": true
},
"deal_cost_rates": {
"type": "switch",
"available": true
},
"custom_man_days": {
"type": "switch",
"available": true
},
"workload_view": {
"type": "switch",
"available": true
},
"xero_expense_sync": {
"type": "switch",
"available": true
},
"rippling_integration": {
"type": "switch",
"available": true
},
"document_styler": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCH /api/v2/todos/19
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": "todos",
"attributes": {
"description": null
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/description"
}
}
]
}
DELETE /api/v2/todos/1
Requests
DELETE /api/v2/todos/20
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
This response has no content.
DELETE /api/v2/todos/21
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
This response has no content.
Generated by aglio on 28 Mar 2024