API Documentation
Approval Workflows ¶
GET /api/v2/approval_workflows
Requests
GET /api/v2/approval_workflows
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": "approval_workflows",
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
},
"event": {
"data": {
"type": "events",
"id": "1"
}
},
"person": {
"data": {
"type": "people",
"id": "38"
}
},
"approvers": {
"data": []
},
"subscribers": {
"data": []
}
}
},
{
"id": "2",
"type": "approval_workflows",
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
},
"event": {
"data": {
"type": "events",
"id": "2"
}
},
"person": {
"data": {
"type": "people",
"id": "41"
}
},
"approvers": {
"data": []
},
"subscribers": {
"data": []
}
}
},
{
"id": "3",
"type": "approval_workflows",
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
},
"event": {
"data": {
"type": "events",
"id": "3"
}
},
"person": {
"data": {
"type": "people",
"id": "42"
}
},
"approvers": {
"data": []
},
"subscribers": {
"data": []
}
}
},
{
"id": "4",
"type": "approval_workflows",
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
},
"event": {
"data": {
"type": "events",
"id": "4"
}
},
"person": {
"data": {
"type": "people",
"id": "43"
}
},
"approvers": {
"data": []
},
"subscribers": {
"data": []
}
}
}
],
"included": [
{
"id": "1",
"type": "events",
"attributes": {
"name": "test name",
"event_type_id": 2,
"icon_id": null,
"color_id": null,
"archived_at": null,
"limitation_type_id": 2,
"sync_personal_integrations": true,
"half_day_bookings": false,
"description": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
}
}
},
{
"id": "38",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 3,
"email": "user38@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": null,
"last_seen_at": null,
"archived_at": null,
"invited_at": "2024-03-28T05:02:29.000+01:00",
"is_user": true,
"user_id": 38,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:02:29.699+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": "2024-03-28T05:02:29.699+01:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
},
"manager": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "23"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "38"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "2",
"type": "events",
"attributes": {
"name": "test name",
"event_type_id": 2,
"icon_id": null,
"color_id": null,
"archived_at": null,
"limitation_type_id": 2,
"sync_personal_integrations": true,
"half_day_bookings": false,
"description": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
}
}
},
{
"id": "41",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 3,
"email": "user41@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": null,
"last_seen_at": null,
"archived_at": null,
"invited_at": "2024-03-28T05:02:29.000+01:00",
"is_user": true,
"user_id": 41,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:02:29.846+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": "2024-03-28T05:02:29.846+01:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
},
"manager": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "23"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "41"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "3",
"type": "events",
"attributes": {
"name": "test name",
"event_type_id": 2,
"icon_id": null,
"color_id": null,
"archived_at": null,
"limitation_type_id": 2,
"sync_personal_integrations": true,
"half_day_bookings": false,
"description": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
}
}
},
{
"id": "42",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 3,
"email": "user42@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": null,
"last_seen_at": null,
"archived_at": null,
"invited_at": "2024-03-28T05:02:29.000+01:00",
"is_user": true,
"user_id": 42,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:02:29.899+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": "2024-03-28T05:02:29.899+01:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
},
"manager": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "23"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "42"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "4",
"type": "events",
"attributes": {
"name": "test name",
"event_type_id": 2,
"icon_id": null,
"color_id": null,
"archived_at": null,
"limitation_type_id": 2,
"sync_personal_integrations": true,
"half_day_bookings": false,
"description": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
}
}
},
{
"id": "43",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 3,
"email": "user43@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": null,
"last_seen_at": null,
"archived_at": null,
"invited_at": "2024-03-28T05:02:29.000+01:00",
"is_user": true,
"user_id": 43,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:02:29.948+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": "2024-03-28T05:02:29.948+01:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
},
"manager": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "23"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "43"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "23",
"type": "companies",
"attributes": {
"name": "Organization5",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-28T05:02:29.643+01:00",
"last_activity_at": "2024-03-28T05:02:29.643+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "ORGA",
"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": "5"
}
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "38",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
}
}
},
{
"id": "41",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
}
}
},
{
"id": "42",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
}
}
},
{
"id": "43",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "5"
}
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/approval_workflows?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/approval_workflows?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 4,
"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 approval workflowsGET/api/v2/approval_workflows
GET /api/v2/approval_workflows/1
Requests
GET /api/v2/approval_workflows/5
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": "5",
"type": "approval_workflows",
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "6"
}
},
"event": {
"data": {
"type": "events",
"id": "5"
}
},
"person": {
"data": {
"type": "people",
"id": "45"
}
},
"approvers": {
"data": []
},
"subscribers": {
"data": []
}
}
},
"included": [
{
"id": "5",
"type": "events",
"attributes": {
"name": "test name",
"event_type_id": 2,
"icon_id": null,
"color_id": null,
"archived_at": null,
"limitation_type_id": 2,
"sync_personal_integrations": true,
"half_day_bookings": false,
"description": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "6"
}
}
}
},
{
"id": "45",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 3,
"email": "user45@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": null,
"last_seen_at": null,
"archived_at": null,
"invited_at": "2024-03-28T05:02:30.000+01:00",
"is_user": true,
"user_id": 45,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:02:30.206+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": "2024-03-28T05:02:30.206+01:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "6"
}
},
"manager": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "24"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "45"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "24",
"type": "companies",
"attributes": {
"name": "Organization6",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-28T05:02:30.184+01:00",
"last_activity_at": "2024-03-28T05:02:30.185+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "ORGA",
"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": "6"
}
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "45",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "6"
}
}
}
}
],
"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 the approval workflowGET/api/v2/approval_workflows/{id}
URI Parameters
- id
number
(required) Example: 1approval workflow id
POST /api/v2/approval_workflows
Requests
POST /api/v2/approval_workflows
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": "approval_workflows",
"attributes": {
"event_id": 6,
"person_id": 51
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "7",
"type": "approval_workflows",
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "7"
}
},
"event": {
"data": {
"type": "events",
"id": "6"
}
},
"person": {
"data": {
"type": "people",
"id": "51"
}
},
"approvers": {
"data": []
},
"subscribers": {
"data": []
}
}
},
"included": [
{
"id": "6",
"type": "events",
"attributes": {
"name": "test name",
"event_type_id": 2,
"icon_id": null,
"color_id": null,
"archived_at": null,
"limitation_type_id": 2,
"sync_personal_integrations": true,
"half_day_bookings": false,
"description": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "7"
}
}
}
},
{
"id": "51",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 3,
"email": "user51@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": null,
"last_seen_at": null,
"archived_at": null,
"invited_at": "2024-03-28T05:02:30.000+01:00",
"is_user": true,
"user_id": 51,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:02:30.670+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": "2024-03-28T05:02:30.670+01:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "7"
}
},
"manager": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "25"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "51"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "25",
"type": "companies",
"attributes": {
"name": "Organization7",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-28T05:02:30.531+01:00",
"last_activity_at": "2024-03-28T05:02:30.531+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "ORGA",
"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": "7"
}
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "51",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "7"
}
}
}
}
],
"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/approval_workflows
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": "approval_workflows",
"attributes": {
"event_id": 9,
"person_id": 59
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "only one workflow per event, per person is allowed",
"source": {
"pointer": "data/attributes/event"
}
}
]
}
Creates the approval workflowPOST/api/v2/approval_workflows
URI Parameters
- event_id
number
(required) Example: 1event id
- person_id
number
(required) Example: 1person id
- approver_ids
array
(required) Example: %5B1%5Dids of people who need to approve the request
- subscriber_ids
array
(required) Example: %5B1%5Dids of people who will be notified about the request
PATCH /api/v2/approval_workflows/1
Requests
PATCH /api/v2/approval_workflows/11
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": "approval_workflows",
"attributes": {
"approver_ids": [
62
]
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "11",
"type": "approval_workflows",
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "10"
}
},
"event": {
"data": {
"type": "events",
"id": "10"
}
},
"person": {
"data": {
"type": "people",
"id": "61"
}
},
"approvers": {
"data": [
{
"type": "people",
"id": "62"
}
]
},
"subscribers": {
"data": [
{
"type": "people",
"id": "62"
}
]
}
}
},
"included": [
{
"id": "10",
"type": "events",
"attributes": {
"name": "test name",
"event_type_id": 2,
"icon_id": null,
"color_id": null,
"archived_at": null,
"limitation_type_id": 2,
"sync_personal_integrations": true,
"half_day_bookings": false,
"description": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "10"
}
}
}
},
{
"id": "61",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 3,
"email": "user61@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": null,
"last_seen_at": null,
"archived_at": null,
"invited_at": "2024-03-28T05:02:31.000+01:00",
"is_user": true,
"user_id": 61,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:02:31.739+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": "2024-03-28T05:02:31.739+01:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "10"
}
},
"manager": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "28"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "61"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "62",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 2,
"email": "user62@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": null,
"last_seen_at": null,
"archived_at": null,
"invited_at": "2024-03-28T05:02:31.000+01:00",
"is_user": true,
"user_id": 62,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-28T05:02:31.804+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": "2024-03-28T05:02:31.804+01:00",
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "10"
}
},
"manager": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "28"
}
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "62"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "28",
"type": "companies",
"attributes": {
"name": "Organization10",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-28T05:02:31.668+01:00",
"last_activity_at": "2024-03-28T05:02:31.668+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "ORGA",
"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": "10"
}
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "61",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "10"
}
}
}
},
{
"id": "62",
"type": "roles",
"attributes": {
"base_role_id": 2,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "10"
}
}
}
}
],
"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/approval_workflows/12
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": "approval_workflows",
"attributes": {
"person_id": 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/person"
}
}
]
}
Updates the approval workflowPATCH/api/v2/approval_workflows/{id}
URI Parameters
- id
number
(required) Example: 1approval workflow id
DELETE /api/v2/approval_workflows/1
Requests
DELETE /api/v2/approval_workflows/13
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
This response has no content.
Deletes the approval workflowDELETE/api/v2/approval_workflows/{id}
URI Parameters
- id
number
(required) Example: 1approval workflow id
Generated by aglio on 28 Mar 2024