API Documentation
Dashboards ¶
Dashboards ¶
GET /api/v2/dashboards
Requests
GET /api/v2/dashboards
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": "1",
"type": "dashboards",
"attributes": {
"name": "Dashboard a",
"created_at": "2024-03-28T05:04:30.795+01:00",
"updated_at": "2024-03-28T05:04:30.802+01:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "264"
}
},
"creator": {
"data": {
"type": "people",
"id": "926"
}
}
}
}
],
"included": [
{
"id": "926",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user922@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": "2024-03-28T05:04:30.000+01:00",
"last_seen_at": "2024-03-28T05:04:30.829+01:00",
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 922,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:04:30.751+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": "264"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "915"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "915",
"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": "264"
}
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/dashboards?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/dashboards?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 all dashboardsGET/api/v2/dashboards
GET /api/v2/dashboards/1
Requests
GET /api/v2/dashboards/2
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": "2",
"type": "dashboards",
"attributes": {
"name": "Dashboard b",
"created_at": "2024-03-28T05:04:30.956+01:00",
"updated_at": "2024-03-28T05:04:30.963+01:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "265"
}
},
"creator": {
"data": {
"type": "people",
"id": "927"
}
}
}
},
"included": [
{
"id": "927",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user923@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": "2024-03-28T05:04:30.000+01:00",
"last_seen_at": "2024-03-28T05:04:30.982+01:00",
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 923,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:04:30.917+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": "265"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "916"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "916",
"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": "265"
}
}
}
}
],
"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/dashboards
Requests
POST /api/v2/dashboards
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": "dashboards",
"attributes": {
"name": "Test Name"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "6",
"type": "dashboards",
"attributes": {
"name": "Test Name",
"created_at": "2024-03-28T05:04:31.772+01:00",
"updated_at": "2024-03-28T05:04:31.780+01:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "268"
}
},
"creator": {
"data": {
"type": "people",
"id": "932"
}
}
}
},
"included": [
{
"id": "932",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user928@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": "2024-03-28T05:04:31.000+01:00",
"last_seen_at": "2024-03-28T05:04:31.760+01:00",
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 928,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:04:31.648+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": "268"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "921"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "921",
"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": "268"
}
}
}
}
],
"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/dashboards
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": "dashboards",
"attributes": {
"name": ""
}
}
}
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/name"
}
}
]
}
Create a dashboardPOST/api/v2/dashboards
POST /api/v2/dashboards/copy
Requests
POST /api/v2/dashboards/copy
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "dashboards",
"attributes": {
"name": "copied dashboard name",
"copy_memberships": true,
"template_id": 11
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "12",
"type": "dashboards",
"attributes": {
"name": "copied dashboard name",
"created_at": "2024-03-28T05:04:32.511+01:00",
"updated_at": "2024-03-28T05:04:32.537+01:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "272"
}
},
"creator": {
"data": {
"type": "people",
"id": "936"
}
}
}
},
"included": [
{
"id": "936",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user932@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": "2024-03-28T05:04:32.000+01:00",
"last_seen_at": "2024-03-28T05:04:32.500+01:00",
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 932,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:04:32.375+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": "272"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "925"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "925",
"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": "272"
}
}
}
}
],
"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/dashboards/copy
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "dashboards",
"attributes": {
"name": "copied dashboard name",
"copy_memberships": false,
"template_id": 13
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "14",
"type": "dashboards",
"attributes": {
"name": "copied dashboard name",
"created_at": "2024-03-28T05:04:32.709+01:00",
"updated_at": "2024-03-28T05:04:32.713+01:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "273"
}
},
"creator": {
"data": {
"type": "people",
"id": "938"
}
}
}
},
"included": [
{
"id": "938",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user934@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": "2024-03-28T05:04:32.000+01:00",
"last_seen_at": "2024-03-28T05:04:32.701+01:00",
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 934,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:04:32.605+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": "273"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "927"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "927",
"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": "273"
}
}
}
}
],
"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": {}
}
}
Copy a dashboardPOST/api/v2/dashboards/copy
PATCH /api/v2/dashboards/1
Requests
PATCH /api/v2/dashboards/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": "dashboard",
"attributes": {
"name": "dashboard rename"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "16",
"type": "dashboards",
"attributes": {
"name": "dashboard rename",
"created_at": "2024-03-28T05:04:32.911+01:00",
"updated_at": "2024-03-28T05:04:32.943+01:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "275"
}
},
"creator": {
"data": {
"type": "people",
"id": "941"
}
}
}
},
"included": [
{
"id": "941",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user937@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": "2024-03-28T05:04:32.000+01:00",
"last_seen_at": "2024-03-28T05:04:32.932+01:00",
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 937,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:04:32.875+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": "275"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "930"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "930",
"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": "275"
}
}
}
}
],
"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": {}
}
}
Update a dashboardPATCH/api/v2/dashboards/{id}
URI Parameters
- id
number
(required) Example: 1dashboard id
DELETE /api/v2/dashboards/1
Requests
DELETE /api/v2/dashboards/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
Responses
This response has no content.
Delete a dashboardDELETE/api/v2/dashboards/{id}
URI Parameters
- id
number
(required) Example: 1dashboard id
Generated by aglio on 28 Mar 2024