API Documentation
Workflow Statuses ¶
Workflow Statuses ¶
Supported filter params
-
name
-
workflow_id
-
category_id (1: not started, 2: started, 3: closed)
Supported sort params
- name
GET /api/v2/workflow_statuses
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
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "3481",
"type": "workflow_statuses",
"attributes": {
"name": "Open",
"color_id": 1,
"position": 1,
"category_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2140"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2802"
}
}
}
},
{
"id": "3482",
"type": "workflow_statuses",
"attributes": {
"name": "Open",
"color_id": 1,
"position": 1,
"category_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2140"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2802"
}
}
}
},
{
"id": "3483",
"type": "workflow_statuses",
"attributes": {
"name": "Open",
"color_id": 1,
"position": 1,
"category_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2140"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2802"
}
}
}
}
],
"included": [
{
"id": "2802",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2140"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "3481"
},
{
"type": "workflow_statuses",
"id": "3482"
},
{
"type": "workflow_statuses",
"id": "3483"
}
]
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/workflow_statuses?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/workflow_statuses?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 3,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10
},
"public_custom_reports": {
"type": "metered",
"limit": 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 workflow statusesGET/api/v2/workflow_statuses
GET /api/v2/workflow_statuses/3484
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
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3484",
"type": "workflow_statuses",
"attributes": {
"name": "Open",
"color_id": 1,
"position": 1,
"category_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2141"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2803"
}
}
}
},
"included": [
{
"id": "2803",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2141"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "3484"
}
]
}
}
}
],
"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": {}
}
}
Gets a workflow statusGET/api/v2/workflow_statuses/{id}
- id
number
(required) Example: 1workflow_status id
POST /api/v2/workflow_statuses
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": "workflow_statuses",
"attributes": {
"name": "Open",
"color_id": 1,
"category_id": 2
},
"relationships": {
"workflow": {
"data": {
"type": "workflows",
"id": "2804"
}
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3486",
"type": "workflow_statuses",
"attributes": {
"name": "Open",
"color_id": 1,
"position": 1,
"category_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2142"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2804"
}
}
}
},
"included": [
{
"id": "2804",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2142"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "3485"
},
{
"type": "workflow_statuses",
"id": "3486"
}
]
}
}
},
{
"id": "3485",
"type": "workflow_statuses",
"attributes": {
"name": "Open",
"color_id": 1,
"position": 1,
"category_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2142"
}
},
"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/workflow_statuses
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": "workflow_statuses",
"attributes": {
"name": "Open",
"color_id": 1,
"category_id": 2
},
"relationships": {
"workflow": {
"data": {
"type": "workflows",
"id": "2805"
}
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3488",
"type": "workflow_statuses",
"attributes": {
"name": "Open",
"color_id": 1,
"position": 1,
"category_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2143"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2805"
}
}
}
},
"included": [
{
"id": "2805",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2143"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "3487"
},
{
"type": "workflow_statuses",
"id": "3488"
}
]
}
}
},
{
"id": "3487",
"type": "workflow_statuses",
"attributes": {
"name": "Open",
"color_id": 1,
"position": 1,
"category_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2143"
}
},
"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/workflow_statuses
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
{
"type": "workflow_statuses",
"attributes": {
"name": ""
}
}
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"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/workflow"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/category_id"
}
}
]
}
POST /api/v2/workflow_statuses
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
{
"type": "workflow_statuses",
"attributes": {
"name": "Closed 2",
"category_id": "3"
},
"relationships": {
"workflow": {
"data": {
"type": "workflows",
"id": "2807"
}
}
}
}
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"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/workflow"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/category_id"
}
}
]
}
Create an workflow statusPOST/api/v2/workflow_statuses
- name
string
(required) Example: Namename
- workflow_id
number
(required) Example: 1workflow id
- color_id
number
(required) Example: 1color id
- category_id
number
(required) Example: 1workflow status category (1: not started, 2: started, 3: closed)
- position
number
(required) Example: 1position in category
PATCH /api/v2/workflow_statuses/3492
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": "workflow_statuses",
"attributes": {
"name": "Closed"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3492",
"type": "workflow_statuses",
"attributes": {
"name": "Closed",
"color_id": 1,
"position": 1,
"category_id": 2
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2146"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2808"
}
}
}
},
"included": [
{
"id": "2808",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2146"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "3492"
}
]
}
}
}
],
"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/workflow_statuses/3493
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": "workflow_statuses",
"attributes": {
"name": "More closed"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3493",
"type": "workflow_statuses",
"attributes": {
"name": "More closed",
"color_id": 1,
"position": 1,
"category_id": 3
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2147"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "2809"
}
}
}
},
"included": [
{
"id": "2809",
"type": "workflows",
"attributes": {
"name": "Simple workflow",
"archived_at": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "2147"
}
},
"workflow_statuses": {
"data": [
{
"type": "workflow_statuses",
"id": "3493"
}
]
}
}
}
],
"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/workflow_statuses/3494
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": "workflow_statuses",
"attributes": {
"name": ""
}
}
}
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"
}
}
]
}
Update an workflow statusPATCH/api/v2/workflow_statuses/{id}
- id
number
(required) Example: 1workflow_status id
DELETE /api/v2/workflow_statuses/3495
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": "workflow_statuses",
"attributes": {
"target_workflow_status_id": "3503"
}
}
}
DELETE /api/v2/workflow_statuses/3504
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": "workflow_statuses",
"attributes": {
"target_workflow_status_id": "3512"
}
}
}
DELETE /api/v2/workflow_statuses/3513
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": "workflow_statuses",
"attributes": {
"target_workflow_status_id": ""
}
}
}
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/target_workflow_status_id"
}
}
]
}
Deletes a workflow status and moves tasks to other workflow statusDELETE/api/v2/workflow_statuses/{id}
- id
number
(required) Example: 1workflow_status id
- target_workflow_status_id
number
(required) Example: 1workflow status where the tasks from the current workflow status will be moved
Generated by aglio on 28 Mar 2024